< Back

New-NSIP

Sat Jan 11, 2020 12:18 am

NAME New-NSIP



SYNOPSIS

The new-nsip command creates a new NetScaler IP address.





SYNTAX

New-NSIP [-ipaddress] <string> [-netmask] <string> [-arp <string>] [-ftp <string>] [-gui <string>] [-icmp

<string>] [-mgmtaccess <string>] [-restrictaccess <string>] [-returnobject <SwitchParameter>] [-session

<nitro_service>] [-snmp <string>] [-ssh <string>] [-state <string>] [-telnet <string>] [-type <string>] [-vserver

<string>] [<CommonParameters>]





DESCRIPTION

The new-nsip creates a new IP address. Multiple options can be set. As all options are strings, disable options by

setting the value to "DISABLED", or "ENABLED" based on what is needed. For example -gui "ENABLED" enables the GUI

option.





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? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-ftp <string>

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED".



Required? false

Position? named

Default value DISABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-gui <string>

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". Requires mgmtaccess to be enabled as

well.



Required? false

Position? named

Default value DISABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-icmp <string>

This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED".



Required? false

Position? named

Default value ENABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-arp <string>

This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED".



Required? false

Position? named

Default value ENABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ipaddress <string>

Specify the IP address as a string. This is mandatory



Required? true

Position? 0

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-netmask <string>

Specify the netmask as a string. This is mandatory



Required? true

Position? 1

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-mgmtaccess <string>

Enable management access cotnrol. This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED".



Required? false

Position? named

Default value DISABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-restrictaccess <string>

Allow access only to management applications. This parameter is either "DISABLED" or "ENABLED". Default is

"ENABLED".



Required? false

Position? named

Default value ENABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-snmp <string>

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED".



Required? false

Position? named

Default value DISABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ssh <string>

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". Requires mgmtaccess to be enabled as

well.



Required? false

Position? named

Default value DISABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-telnet <string>

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". Requires mgmtaccess to be enabled as

well.



Required? false

Position? named

Default value DISABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-state <string>

This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED".



Required? false

Position? named

Default value ENABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-type <string>

Specify the type of IP address, either SNIP, MIP, CLIP, GSLBsiteIP, LSN. Default is SNIP



Required? false

Position? named

Default value SNIP

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-vserver <string>

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED".



Required? false

Position? named

Default value DISABLED

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-returnobject <SwitchParameter>

If set to true, the object that is created 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.



System.String

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED".



System.String

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". Requires mgmtaccess to be enabled as

well.



System.String

This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED".



System.String

This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED".



System.String

Specify the IP address as a string. This is mandatory



System.String

Specify the netmask as a string. This is mandatory



System.String

Enable management access cotnrol. This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED".



System.String

Allow access only to management applications. This parameter is either "DISABLED" or "ENABLED". Default is

"ENABLED".



System.String

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED".



System.String

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". Requires mgmtaccess to be enabled as

well.



System.String

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". Requires mgmtaccess to be enabled as

well.



System.String

This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED".



System.String

Specify the type of IP address, either SNIP, MIP, CLIP, GSLBsiteIP, LSN. Default is SNIP



System.String

This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED".



System.Management.Automation.SwitchParameter

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





OUTPUTS

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





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



new-NSIP -ipaddress "10.0.1.1" -netmask "255.255.255.0"



create a subnet IP

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



new-NSIP -ipaddress "10.0.1.1" -netmask "255.255.255.0" -type "MIP" -returnobject $true



create a MIP, and return the address that was created as an object

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



new-NSIP -ipaddress "10.0.1.1" -netmask "255.255.255.0" -gui "ENABLED" -mgmtaccess "ENABLED"



create a SNIP and enable GUI and management



RELATED LINKS