Invoke ADCAddRnat - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddRnat

SYNOPSIS

Add Network configuration Object.

SYNTAX

Invoke-ADCAddRnat [-Name] <String> [[-Network] <String>] [[-Netmask] <String>] [[-Aclname] <String>]
 [[-Redirectport] <Int32>] [[-Td] <Double>] [[-Srcippersistency] <String>] [[-Useproxyport] <String>]
 [[-Connfailover] <String>] [[-Ownergroup] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for RNAT configured route resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddRnat -name <string>

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

PARAMETERS

-Name

Name for the RNAT4 rule. Must begin with a letter, number, or the underscore character (_), and can consist of letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore characters. Cannot be changed after the rule is created. Choose a name that helps identify the RNAT4 rule.

Type: String
Parameter Sets: (All)
Aliases:

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

-Network

The network address defined for the RNAT entry.

Type: String
Parameter Sets: (All)
Aliases:

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

-Netmask

The subnet mask for the network address.

Type: String
Parameter Sets: (All)
Aliases:

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

-Aclname

An extended ACL defined for the RNAT entry.

Type: String
Parameter Sets: (All)
Aliases:

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

-Redirectport

Port number to which the IPv4 packets are redirected. Applicable to TCP and UDP protocols.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Srcippersistency

Enables the Citrix ADC to use the same NAT IP address for all RNAT sessions initiated from a particular server. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Useproxyport

Enable source port proxying, which enables the Citrix ADC to use the RNAT ips using proxied source port. 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

-Connfailover

Synchronize connection information with the secondary appliance in a high availability (HA) pair. That is, synchronize all connection-related information for the RNAT session. In order for this to work, tcpproxy should be DISABLED. To disable tcpproxy use "set rnatparam tcpproxy DISABLED". Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Ownergroup

The owner node group in a Cluster for this rnat rule.

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

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