Invoke ADCAddChannel - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddChannel

SYNOPSIS

Add Network configuration Object.

SYNTAX

Invoke-ADCAddChannel [-Id] <String> [[-Ifnum] <String[]>] [[-State] <String>] [[-Mode] <String>]
 [[-Conndistr] <String>] [[-Macdistr] <String>] [[-Lamac] <String>] [[-Speed] <String>] [[-Flowctl] <String>]
 [[-Hamonitor] <String>] [[-Haheartbeat] <String>] [[-Tagall] <String>] [[-Trunk] <String>]
 [[-Ifalias] <String>] [[-Throughput] <Double>] [[-Bandwidthhigh] <Double>] [[-Bandwidthnormal] <Double>]
 [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for channel resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddChannel -id <string>

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

PARAMETERS

-Id

ID for the LA channel or cluster LA channel or LR channel to be created. Specify an LA channel in LA/x notation, where x can range from 1 to 8 or cluster LA channel in CLA/x notation or Link redundant channel in LR/x notation, where x can range from 1 to 4. Cannot be changed after the LA channel is created.

Type: String
Parameter Sets: (All)
Aliases:

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

-Ifnum

Interfaces to be bound to the LA channel of a Citrix ADC or to the LA channel of a cluster configuration. For an LA channel of a Citrix ADC, specify an interface in C/U notation (for example, 1/3). For an LA channel of a cluster configuration, specify an interface in N/C/U notation (for example, 2/1/3). where C can take one of the following values:

  • 0 - Indicates a management interface.
  • 1 - Indicates a 1 Gbps port.
  • 10 - Indicates a 10 Gbps port. U is a unique integer for representing an interface in a particular port group. N is the ID of the node to which an interface belongs in a cluster configuration. Use spaces to separate multiple entries.
Type: String[]
Parameter Sets: (All)
Aliases:

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

-State

Enable or disable the LA channel. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Mode

The initital mode for the LA channel. Possible values = MANUAL, AUTO

Type: String
Parameter Sets: (All)
Aliases:

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

-Conndistr

The 'connection' distribution mode for the LA channel. Possible values = DISABLED, ENABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Macdistr

The 'MAC' distribution mode for the LA channel. Possible values = SOURCE, DESTINATION, BOTH

Type: String
Parameter Sets: (All)
Aliases:

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

-Lamac

Specifies a MAC address for the LA channels configured in Citrix ADC virtual appliances (VPX). This MAC address is persistent after each reboot. If you don't specify this parameter, a MAC address is generated randomly for each LA channel. These MAC addresses change after each reboot.

Type: String
Parameter Sets: (All)
Aliases:

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

-Speed

Ethernet speed of the channel, in Mbps. If the speed of any bound interface is greater than or equal to the value set for this parameter, the state of the interface is UP. Otherwise, the state is INACTIVE. Bound Interfaces whose state is INACTIVE do not process any traffic. Possible values = AUTO, 10, 100, 1000, 10000, 25000, 40000, 50000, 100000

Type: String
Parameter Sets: (All)
Aliases:

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

-Flowctl

Specifies the flow control type for this LA channel to manage the flow of frames. Flow control is a function as mentioned in clause 31 of the IEEE 802.3 standard. Flow control allows congested ports to pause traffic from the peer device. Flow control is achieved by sending PAUSE frames. Possible values = OFF, RX, TX, RXTX, ON

Type: String
Parameter Sets: (All)
Aliases:

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

-Hamonitor

In a High Availability (HA) configuration, monitor the LA channel for failure events. Failure of any LA channel that has HA MON enabled triggers HA failover. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Haheartbeat

In a High Availability (HA) configuration, configure the LA channel for sending heartbeats. LA channel that has HA Heartbeat disabled should not send the heartbeats. Possible values = OFF, ON

Type: String
Parameter Sets: (All)
Aliases:

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

-Tagall

Adds a four-byte 802.1q tag to every packet sent on this channel. The ON setting applies tags for all VLANs that are bound to this channel. OFF applies the tag for all VLANs other than the native VLAN. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Trunk

This is deprecated by tagall. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Ifalias

Alias name for the LA channel. Used only to enhance readability. To perform any operations, you have to specify the LA channel ID.

Type: String
Parameter Sets: (All)
Aliases:

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

-Throughput

Low threshold value for the throughput of the LA channel, in Mbps. In an high availability (HA) configuration, failover is triggered when the LA channel has HA MON enabled and the throughput is below the specified threshold.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Bandwidthhigh

High threshold value for the bandwidth usage of the LA channel, in Mbps. The Citrix ADC generates an SNMP trap message when the bandwidth usage of the LA channel is greater than or equal to the specified high threshold value.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Bandwidthnormal

Normal threshold value for the bandwidth usage of the LA channel, in Mbps. When the bandwidth usage of the LA channel returns to less than or equal to the specified normal threshold after exceeding the high threshold, the Citrix ADC generates an SNMP trap message to indicate that the bandwidth usage has returned to normal.

Type: Double
Parameter Sets: (All)
Aliases:

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

-PassThru

Return details about the created channel item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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-ADCAddChannel Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/network/channel/ 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** ⚠️