< Back

Set-NSIP

Sat Jan 11, 2020 1:33 am

NAME Set-NSIP



SYNOPSIS

The set-nsip allows you to save changes made to a ip object.





SYNTAX

Set-NSIP [[-session] <nitro_service>] [-nsipToModify] <nsip> [-returnobject <SwitchParameter>] [<CommonParameters>]





DESCRIPTION

Get an IP object with get-nsip, change it, and use set-nsip to submit the changes. Note, not all properties can be

changed.





PARAMETERS

-session <nitro_service>

This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and

pipelined into this command.



Required? false

Position? 0

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-nsipToModify <nsip>

Specify the NSIP to modify. This requires an NSIP object as returned by get-nsip. Please note, this does not

take an array.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-returnobject <SwitchParameter>

If set to true, the object that is updated is returned. This is useful to testing purposes.



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

com.citrix.netscaler.nitro.service.nitro_service

This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and

pipelined into this command.



com.citrix.netscaler.nitro.resource.config.ns.nsip

Specify the NSIP to modify. This requires an NSIP object as returned by get-nsip. Please note, this does not

take an array.



System.Management.Automation.SwitchParameter

If set to true, the object that is updated is returned. This is useful to testing purposes.





OUTPUTS



---------- EXAMPLE 1 ----------



set-nsip -nsiptomodify $ip



get an IP, change it and submit the changes



RELATED LINKS