Package com.vmware.nsx_policy.global_infra.tier_1s.nat

Interface NatRules

All Superinterfaces:

NatRulesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

NatRulesStub

public interface NatRules
extends com.vmware.vapi.bindings.Service, NatRulesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.global_infra.tier_1s.nat.NatRulesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
PolicyNatRule	get(java.lang.String tier1Id, java.lang.String natId, java.lang.String natRuleId)	Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by .
void	get(java.lang.String tier1Id, java.lang.String natId, java.lang.String natRuleId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatRule> asyncCallback)	Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by .
void	get(java.lang.String tier1Id, java.lang.String natId, java.lang.String natRuleId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by .
PolicyNatRule	get(java.lang.String tier1Id, java.lang.String natId, java.lang.String natRuleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by .
PolicyNatRuleListResult	list(java.lang.String tier1Id, java.lang.String natId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by .
void	list(java.lang.String tier1Id, java.lang.String natId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatRuleListResult> asyncCallback)	List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by .
void	list(java.lang.String tier1Id, java.lang.String natId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatRuleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by .
PolicyNatRuleListResult	list(java.lang.String tier1Id, java.lang.String natId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by .

Method Detail

get

PolicyNatRule get(java.lang.String tier1Id,
                  java.lang.String natId,
                  java.lang.String natRuleId)

Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by . Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

tier1Id - Tier-1 ID (required)

natId - NAT id (required)

natRuleId - Rule ID (required)

Returns:

com.vmware.nsx_policy.model.PolicyNatRule

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

PolicyNatRule get(java.lang.String tier1Id,
                  java.lang.String natId,
                  java.lang.String natRuleId,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by . Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

tier1Id - Tier-1 ID (required)

natId - NAT id (required)

natRuleId - Rule ID (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyNatRule

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String tier1Id,
         java.lang.String natId,
         java.lang.String natRuleId,
         com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatRule> asyncCallback)

Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by . Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx_policy.model.PolicyNatRule

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

tier1Id - Tier-1 ID (required)

natId - NAT id (required)

natRuleId - Rule ID (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String tier1Id,
         java.lang.String natId,
         java.lang.String natRuleId,
         com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatRule> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by . Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx_policy.model.PolicyNatRule

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

tier1Id - Tier-1 ID (required)

natId - NAT id (required)

natRuleId - Rule ID (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

PolicyNatRuleListResult list(java.lang.String tier1Id,
                             java.lang.String natId,
                             java.lang.String cursor,
                             java.lang.Boolean includeMarkForDeleteObjects,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy)

List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by . Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

tier1Id - Tier-1 ID (required)

natId - NAT id (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx_policy.model.PolicyNatRuleListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

PolicyNatRuleListResult list(java.lang.String tier1Id,
                             java.lang.String natId,
                             java.lang.String cursor,
                             java.lang.Boolean includeMarkForDeleteObjects,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by . Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

tier1Id - Tier-1 ID (required)

natId - NAT id (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyNatRuleListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String tier1Id,
          java.lang.String natId,
          java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatRuleListResult> asyncCallback)

List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by . Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx_policy.model.PolicyNatRuleListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

tier1Id - Tier-1 ID (required)

natId - NAT id (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String tier1Id,
          java.lang.String natId,
          java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatRuleListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by . Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx_policy.model.PolicyNatRuleListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

tier1Id - Tier-1 ID (required)

natId - NAT id (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.