Invoke ADCAddIptunnel - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddIptunnel

SYNOPSIS

Add Network configuration Object.

SYNTAX

Invoke-ADCAddIptunnel [-Name] <String> [-Remote] <String> [-Remotesubnetmask] <String> [-Local] <String>
 [[-Protocol] <String>] [[-Grepayload] <String>] [[-Ipsecprofilename] <String>] [[-Vlan] <Double>]
 [[-Ownergroup] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for ip Tunnel resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddIptunnel -name <string> -remote <string> -remotesubnetmask <string> -local <string>

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

PARAMETERS

-Name

Name for the IP tunnel. Leading character must be a number or letter. Other characters allowed, after the first character, are @ _ - . (period) : (colon) # and space ( ).

Type: String
Parameter Sets: (All)
Aliases:

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

-Remote

Public IPv4 address, of the remote device, used to set up the tunnel. For this parameter, you can alternatively specify a network address.

Type: String
Parameter Sets: (All)
Aliases:

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

-Remotesubnetmask

Subnet mask of the remote IP address of the tunnel.

Type: String
Parameter Sets: (All)
Aliases:

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

-Local

Type of Citrix ADC owned public IPv4 address, configured on the local Citrix ADC and used to set up the tunnel.

Type: String
Parameter Sets: (All)
Aliases:

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

-Protocol

Name of the protocol to be used on this tunnel. Possible values = IPIP, GRE, IPSEC, UDP

Type: String
Parameter Sets: (All)
Aliases:

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

-Grepayload

The payload GRE will carry. Possible values = ETHERNETwithDOT1Q, ETHERNET, IP

Type: String
Parameter Sets: (All)
Aliases:

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

-Ipsecprofilename

Name of IPSec profile to be associated.

Type: String
Parameter Sets: (All)
Aliases:

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

-Vlan

The vlan for mulicast packets.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Ownergroup

The owner node group in a Cluster for the iptunnel.

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

Return details about the created iptunnel 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-ADCAddIptunnel Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/network/iptunnel/ 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** ⚠️