port_forwarding_rules_obj

Configuration Editor for API to add, modify, delete, and get configuration for Port forwarding rules resource.

Read/write properties

protocol <String>

The IP protocol to forward.. Possible values = [both,TCP,UDP]

outside_port <String>

The Outside port or port range to forward..

log_connection_end <Boolean>

To generate a log when a Connection matching this Rule is deleted..

inside_network_ip_address <String>

The Inside IP address to forward to..

track_connection <Boolean>

Whether or not to enable bidirectional connection state tracking for TCP, UDP and ICMP packets matching this Rule. This feature will block flows which appear illegitimate, due to asymmetric routing or failure of checksum, protocol specific validation -- proceed with caution if NetScaler SD-WAN is not fully inline..

log_interval <Integer>

The time, in seconds, between logging the number of packets matching the rule (0 = disabled, valid settings are 60-600)..

inside_port <String>

The Inside port or port range to forward to. If a range is configured, it must define the name number of ports as the Outside Port..

log_connection_start <Boolean>

To generate a log when a new Connection is created by a packet matching this Rule..

allow_fragments <Boolean>

To enable forwarding of packet fragments..

Read only properties

Operations

add delete get (all) modify

[add]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/port_forwarding_rules_obj

Description: Use this operation to add the Port forwarding rules

HTTP Method: POST

Request Payload: JSON

{"port_forwarding_rules_obj": { "protocol":<String_value> , "outside_port":<String_value> , "log_connection_end":<Boolean_value> , "inside_network_ip_address":<String_value> , "track_connection":<Boolean_value> , "log_interval":<Integer_value> , "inside_port":<String_value> , "log_connection_start":<Boolean_value> , "allow_fragments":<Boolean_value> }}

Response Payload: JSON

{ "port_forwarding_rules_obj":{ "protocol":<String_value>

, "outside_port":<String_value> , "log_connection_end":<Boolean_value> , "inside_network_ip_address":<String_value> , "track_connection":<Boolean_value> , "log_interval":<Integer_value> , "inside_port":<String_value> , "log_connection_start":<Boolean_value> , "allow_fragments":<Boolean_value> }]}

[delete]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/port_forwarding_rules_obj/

Description: Use this operation to delete the Port forwarding rules

HTTP Method: DELETE

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String;_value> }

[get (all)]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/port_forwarding_rules_obj

Description: Use this operation to get the Port forwarding rules

HTTP Method: GET

Response Payload: JSON

{"port_forwarding_rules_obj":[{ "protocol":<String_value>

, "outside_port":<String_value> , "log_connection_end":<Boolean_value> , "inside_network_ip_address":<String_value> , "track_connection":<Boolean_value> , "log_interval":<Integer_value> , "inside_port":<String_value> , "log_connection_start":<Boolean_value> , "allow_fragments":<Boolean_value> }]}

[modify]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/port_forwarding_rules_obj

Description: Use this operation to modify the Port forwarding rules

HTTP Method: PUT

Request Payload: JSON

{"port_forwarding_rules_obj":{ "protocol":<String_value> , "outside_port":<String_value> , "log_connection_end":<Boolean_value> , "inside_network_ip_address":<String_value> , "track_connection":<Boolean_value> , "log_interval":<Integer_value> , "inside_port":<String_value> , "log_connection_start":<Boolean_value> , "allow_fragments":<Boolean_value> }}

Response Payload: JSON

{ "port_forwarding_rules_obj":[{ "protocol":<String_value>

, "outside_port":<String_value> , "log_connection_end":<Boolean_value> , "inside_network_ip_address":<String_value> , "track_connection":<Boolean_value> , "log_interval":<Integer_value> , "inside_port":<String_value> , "log_connection_start":<Boolean_value> , "allow_fragments":<Boolean_value> }]}