Invoke-ADCAddNsip

SYNOPSIS

Add NS configuration Object.

SYNTAX

Invoke-ADCAddNsip [-Ipaddress] <String> [-Netmask] <String> [[-Type] <String>] [[-Arp] <String>]
 [[-Icmp] <String>] [[-Vserver] <String>] [[-Telnet] <String>] [[-Ftp] <String>] [[-Gui] <String>]
 [[-Ssh] <String>] [[-Snmp] <String>] [[-Mgmtaccess] <String>] [[-Restrictaccess] <String>]
 [[-Dynamicrouting] <String>] [[-Decrementttl] <String>] [[-Ospf] <String>] [[-Bgp] <String>] [[-Rip] <String>]
 [[-Hostroute] <String>] [[-Advertiseondefaultpartition] <String>] [[-Networkroute] <String>] [[-Tag] <Double>]
 [[-Hostrtgw] <String>] [[-Metric] <Int32>] [[-Vserverrhilevel] <String>] [[-Ospflsatype] <String>]
 [[-Ospfarea] <Double>] [[-State] <String>] [[-Vrid] <Double>] [[-Icmpresponse] <String>]
 [[-Ownernode] <Double>] [[-Arpresponse] <String>] [[-Ownerdownresponse] <String>] [[-Td] <Double>]
 [[-Arpowner] <Double>] [[-Mptcpadvertise] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for ip resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddNsip -ipaddress <string> -netmask <string>

An example how to add nsip configuration Object(s).

PARAMETERS

-Ipaddress

IPv4 address to create on the Citrix ADC. Cannot be changed after the IP address is created.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Netmask

Subnet mask associated with the IP address.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type

Type of the IP address to create on the Citrix ADC. Cannot be changed after the IP address is created. The following are the different types of Citrix ADC owned IP addresses:

A Subnet IP (SNIP) address is used by the Citrix ADC to communicate with the servers. The Citrix ADC also uses the subnet IP address when generating its own packets, such as packets related to dynamic routing protocols, or to send monitor probes to check the health of the servers.
A Virtual IP (VIP) address is the IP address associated with a virtual server. It is the IP address to which clients connect. An appliance managing a wide range of traffic may have many VIPs configured. Some of the attributes of the VIP address are customized to meet the requirements of the virtual server.
A GSLB site IP (GSLBIP) address is associated with a GSLB site. It is not mandatory to specify a GSLBIP address when you initially configure the Citrix ADC. A GSLBIP address is used only when you create a GSLB site.
A Cluster IP (CLIP) address is the management address of the cluster. All cluster configurations must be performed by accessing the cluster through this IP address. Possible values = SNIP, VIP, NSIP, GSLBsiteIP, CLIP

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: SNIP
Accept pipeline input: False
Accept wildcard characters: False

-Arp

Respond to ARP requests for this IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Icmp

Respond to ICMP requests for this IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Vserver

Use this option to set (enable or disable) the virtual server attribute for this IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Telnet

Allow Telnet access to this IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Ftp

Allow File Transfer Protocol (FTP) access to this IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Gui

Allow graphical user interface (GUI) access to this IP address. Possible values = ENABLED, SECUREONLY, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Ssh

Allow secure shell (SSH) access to this IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Snmp

Allow Simple Network Management Protocol (SNMP) access to this IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Mgmtaccess

Allow access to management applications on this IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Restrictaccess

Block access to nonmanagement applications on this IP. This option is applicable for MIPs, SNIPs, and NSIP, and is disabled by default. Nonmanagement applications can run on the underlying Citrix ADC Free BSD operating system. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Dynamicrouting

Allow dynamic routing on this IP address. Specific to Subnet IP (SNIP) address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Decrementttl

Decrement TTL by 1 when ENABLED.This setting is applicable only for UDP traffic. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Ospf

Use this option to enable or disable OSPF on this IP address for the entity. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Bgp

Use this option to enable or disable BGP on this IP address for the entity. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Rip

Use this option to enable or disable RIP on this IP address for the entity. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Hostroute

Option to push the VIP to ZebOS routing table for Kernel route redistribution through dynamic routing protocols. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Advertiseondefaultpartition

Advertise VIPs from Shared VLAN on Default Partition. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Networkroute

Option to push the SNIP subnet to ZebOS routing table for Kernel route redistribution through dynamic routing protocol. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tag

Tag value for the network/host route associated with this IP.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 23
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Hostrtgw

IP address of the gateway of the route for this VIP address.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 24
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False

-Metric

Integer value to add to or subtract from the cost of the route advertised for the VIP address.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 25
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Vserverrhilevel

Advertise the route for the Virtual IP (VIP) address on the basis of the state of the virtual servers associated with that VIP.

NONE - Advertise the route for the VIP address, regardless of the state of the virtual servers associated with the address.
ONE VSERVER - Advertise the route for the VIP address if at least one of the associated virtual servers is in UP state.
ALL VSERVER - Advertise the route for the VIP address if all of the associated virtual servers are in UP state.
VSVR_CNTRLD - Advertise the route for the VIP address according to the RHIstate (RHI STATE) parameter setting on all the associated virtual servers of the VIP address along with their states. When Vserver RHI Level (RHI) parameter is set to VSVR_CNTRLD, the following are different RHI behaviors for the VIP address on the basis of RHIstate (RHI STATE) settings on the virtual servers associated with the VIP address:
If you set RHI STATE to PASSIVE on all virtual servers, the Citrix ADC always advertises the route for the VIP address.
If you set RHI STATE to ACTIVE on all virtual servers, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers is in UP state. *If you set RHI STATE to ACTIVE on some and PASSIVE on others, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers, whose RHI STATE set to ACTIVE, is in UP state. Possible values = ONE_VSERVER, ALL_VSERVERS, NONE, VSVR_CNTRLD

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 26
Default value: ONE_VSERVER
Accept pipeline input: False
Accept wildcard characters: False

-Ospflsatype

Type of LSAs to be used by the OSPF protocol, running on the Citrix ADC, for advertising the route for this VIP address. Possible values = TYPE1, TYPE5

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 27
Default value: TYPE5
Accept pipeline input: False
Accept wildcard characters: False

-Ospfarea

ID of the area in which the type1 link-state advertisements (LSAs) are to be advertised for this virtual IP (VIP) address by the OSPF protocol running on the Citrix ADC. When this parameter is not set, the VIP is advertised on all areas.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 28
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False

-State

Enable or disable the IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 29
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Vrid

A positive integer that uniquely identifies a VMAC address for binding to this VIP address. This binding is used to set up Citrix ADCs in an active-active configuration using VRRP.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 30
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Icmpresponse

Respond to ICMP requests for a Virtual IP (VIP) address on the basis of the states of the virtual servers associated with that VIP. Available settings function as follows:

NONE - The Citrix ADC responds to any ICMP request for the VIP address, irrespective of the states of the virtual servers associated with the address.
ONE VSERVER - The Citrix ADC responds to any ICMP request for the VIP address if at least one of the associated virtual servers is in UP state.
ALL VSERVER - The Citrix ADC responds to any ICMP request for the VIP address if all of the associated virtual servers are in UP state.
VSVR_CNTRLD - The behavior depends on the ICMP VSERVER RESPONSE setting on all the associated virtual servers. The following settings can be made for the ICMP VSERVER RESPONSE parameter on a virtual server:
If you set ICMP VSERVER RESPONSE to PASSIVE on all virtual servers, Citrix ADC always responds.
If you set ICMP VSERVER RESPONSE to ACTIVE on all virtual servers, Citrix ADC responds if even one virtual server is UP.
When you set ICMP VSERVER RESPONSE to ACTIVE on some and PASSIVE on others, Citrix ADC responds if even one virtual server set to ACTIVE is UP. Possible values = NONE, ONE_VSERVER, ALL_VSERVERS, VSVR_CNTRLD

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 31
Default value: 5
Accept pipeline input: False
Accept wildcard characters: False

-Ownernode

The owner node in a Cluster for this IP address. Owner node can vary from 0 to 31. If ownernode is not specified then the IP is treated as Striped IP.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 32
Default value: 255
Accept pipeline input: False
Accept wildcard characters: False

-Arpresponse

Respond to ARP requests for a Virtual IP (VIP) address on the basis of the states of the virtual servers associated with that VIP. Available settings function as follows:

NONE - The Citrix ADC responds to any ARP request for the VIP address, irrespective of the states of the virtual servers associated with the address.
ONE VSERVER - The Citrix ADC responds to any ARP request for the VIP address if at least one of the associated virtual servers is in UP state.
ALL VSERVER - The Citrix ADC responds to any ARP request for the VIP address if all of the associated virtual servers are in UP state. Possible values = NONE, ONE_VSERVER, ALL_VSERVERS

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 33
Default value: 5
Accept pipeline input: False
Accept wildcard characters: False

-Ownerdownresponse

in cluster system, if the owner node is down, whether should it respond to icmp/arp. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 34
Default value: YES
Accept pipeline input: False
Accept wildcard characters: False

-Td

Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. TD id 4095 is used reserved for LSN use .

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 35
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Arpowner

The arp owner in a Cluster for this IP address. It can vary from 0 to 31.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 36
Default value: 255
Accept pipeline input: False
Accept wildcard characters: False

-Mptcpadvertise

If enabled, this IP will be advertised by Citrix ADC to MPTCP enabled clients as part of ADD_ADDR option. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 37
Default value: NO
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCAddNsip Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ns/nsip/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.