Get-NSIP

NAME Get-NSIP



SYNOPSIS

The get-nsip returns all ip addresses as objects.





SYNTAX

Get-NSIP [[-session] <nitro_service>] [[-filter] <string>] [<CommonParameters>]





DESCRIPTION

The get-nsip command returns a NSIP object. Some of the values of this object can be changed and pushed back to

the NetScaler with the set-NSIP command.





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



-filter <string>

This optional parameter requires allows you to specify a filter. e.g. "ipaddress:x.x.x.x", or "iptype:vip"



Required? false

Position? 1

Default value

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.



System.String

This optional parameter requires allows you to specify a filter. e.g. "ipaddress:x.x.x.x", or "iptype:vip"





OUTPUTS

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





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



get-NSIP



retrieve all NetScaler IPs

---------- EXAMPLE 2 ----------



get-NSIP -filter "iptype:snip"



retrieve all subnet IPs

---------- EXAMPLE 3 ----------



get the IP based on IP addressget-NSIP -filter "ipaddress:10.0.1.1"



get the IP based on IP address



RELATED LINKS