Invoke ADCUpdateNsip6 - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUpdateNsip6

SYNOPSIS

Update NS configuration Object.

SYNTAX

Invoke-ADCUpdateNsip6 [-Ipv6address] <String> [[-Td] <Double>] [[-Nd] <String>] [[-Icmp] <String>]
 [[-Vserver] <String>] [[-Telnet] <String>] [[-Ftp] <String>] [[-Gui] <String>] [[-Ssh] <String>]
 [[-Snmp] <String>] [[-Mgmtaccess] <String>] [[-Ownerdownresponse] <String>] [[-Restrictaccess] <String>]
 [[-State] <String>] [[-Map] <String>] [[-Decrementhoplimit] <String>] [[-Dynamicrouting] <String>]
 [[-Hostroute] <String>] [[-Advertiseondefaultpartition] <String>] [[-Networkroute] <String>]
 [[-Ip6hostrtgw] <String>] [[-Metric] <Int32>] [[-Vserverrhilevel] <String>] [[-Ospf6lsatype] <String>]
 [[-Ospfarea] <Double>] [[-Tag] <Double>] [[-Vrid6] <Double>] [[-Ndowner] <Double>]
 [[-Mptcpadvertise] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for ip6 resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateNsip6 -ipv6address <string>

An example how to update nsip6 configuration Object(s).

PARAMETERS

-Ipv6address

IPv6 address to create on the Citrix ADC.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
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.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Nd

Respond to Neighbor Discovery (ND) requests for this IP address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
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: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Vserver

Enable or disable the state of all the virtual servers associated with this VIP6 address. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
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: 7
Default value: None
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: 8
Default value: None
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: 9
Default value: None
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: 10
Default value: None
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: 11
Default value: None
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: 12
Default value: None
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: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Restrictaccess

Block access to nonmanagement applications on this IP address. This option is applicable forMIP6s, SNIP6s, and NSIP6s, 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: None
Accept pipeline input: False
Accept wildcard characters: False

-State

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

Type: String
Parameter Sets: (All)
Aliases:

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

-Map

Mapped IPV4 address for the IPV6 address.

Type: String
Parameter Sets: (All)
Aliases:

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

-Decrementhoplimit

Decrement Hop Limit 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: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Dynamicrouting

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

Type: String
Parameter Sets: (All)
Aliases:

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

-Hostroute

Option to push the VIP6 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: 19
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: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Networkroute

Option to push the SNIP6 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: 21
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ip6hostrtgw

IPv6 address of the gateway for the route. If Gateway is not set, VIP uses :: as the gateway.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: None
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 VIP6 address.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Vserverrhilevel

Advertise or do not advertise the route for the Virtual IP (VIP6) address on the basis of the state of the virtual servers associated with that VIP6.

  • NONE - Advertise the route for the VIP6 address, irrespective of the state of the virtual servers associated with the address.
  • ONE VSERVER - Advertise the route for the VIP6 address if at least one of the associated virtual servers is in UP state.
  • ALL VSERVER - Advertise the route for the VIP6 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: 24
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ospf6lsatype

Type of LSAs to be used by the IPv6 OSPF protocol, running on the Citrix ADC, for advertising the route for the VIP6 address. Possible values = INTRA_AREA, EXTERNAL

Type: String
Parameter Sets: (All)
Aliases:

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

-Ospfarea

ID of the area in which the Intra-Area-Prefix LSAs are to be advertised for the VIP6 address by the IPv6 OSPF protocol running on the Citrix ADC. When ospfArea is not set, VIP6 is advertised on all areas.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 26
Default value: 0
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: 27
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Vrid6

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: 28
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Ndowner

NdOwner in Cluster for VIPS and Striped SNIPS.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 29
Default value: 0
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: 30
Default value: None
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-ADCUpdateNsip6 Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ns/nsip6/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️