com.vmware.nsx.firewall.sections

Interface Rules

All Superinterfaces:

RulesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RulesStub

public interface Rules
extends com.vmware.vapi.bindings.Service, RulesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.firewall.sections.RulesTypes

_VAPI_SERVICE_ID, CREATE_OPERATION_AFTER, CREATE_OPERATION_BEFORE, CREATE_OPERATION_BOTTOM, CREATE_OPERATION_TOP, CREATEMULTIPLE_OPERATION_AFTER, CREATEMULTIPLE_OPERATION_BEFORE, CREATEMULTIPLE_OPERATION_BOTTOM, CREATEMULTIPLE_OPERATION_TOP, LIST_FILTER_TYPE_FILTER, LIST_FILTER_TYPE_SEARCH, REVISE_OPERATION_AFTER, REVISE_OPERATION_BEFORE, REVISE_OPERATION_BOTTOM, REVISE_OPERATION_TOP

Method Summary

Modifier and Type	Method and Description
FirewallRule	create(java.lang.String sectionId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation) Deprecated.
void	create(java.lang.String sectionId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback) Deprecated.
void	create(java.lang.String sectionId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRule	create(java.lang.String sectionId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRuleList	createmultiple(java.lang.String sectionId, FirewallRuleList firewallRuleList, java.lang.String id, java.lang.String operation) Deprecated.
void	createmultiple(java.lang.String sectionId, FirewallRuleList firewallRuleList, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleList> asyncCallback) Deprecated.
void	createmultiple(java.lang.String sectionId, FirewallRuleList firewallRuleList, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRuleList	createmultiple(java.lang.String sectionId, FirewallRuleList firewallRuleList, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String sectionId, java.lang.String ruleId) Deprecated.
void	delete(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRule	get(java.lang.String sectionId, java.lang.String ruleId) Deprecated.
void	get(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback) Deprecated.
void	get(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRule	get(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRuleListResult	list(java.lang.String sectionId, java.lang.String appliedTos, java.lang.String contextProfiles, java.lang.String cursor, java.lang.Boolean deepSearch, java.lang.String destinations, java.lang.String extendedSources, java.lang.String filterType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean searchInvalidReferences, java.lang.String services, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String sources) Deprecated.
void	list(java.lang.String sectionId, java.lang.String appliedTos, java.lang.String contextProfiles, java.lang.String cursor, java.lang.Boolean deepSearch, java.lang.String destinations, java.lang.String extendedSources, java.lang.String filterType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean searchInvalidReferences, java.lang.String services, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String sources, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleListResult> asyncCallback) Deprecated.
void	list(java.lang.String sectionId, java.lang.String appliedTos, java.lang.String contextProfiles, java.lang.String cursor, java.lang.Boolean deepSearch, java.lang.String destinations, java.lang.String extendedSources, java.lang.String filterType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean searchInvalidReferences, java.lang.String services, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String sources, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRuleListResult	list(java.lang.String sectionId, java.lang.String appliedTos, java.lang.String contextProfiles, java.lang.String cursor, java.lang.Boolean deepSearch, java.lang.String destinations, java.lang.String extendedSources, java.lang.String filterType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean searchInvalidReferences, java.lang.String services, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String sources, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRule	revise(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation) Deprecated.
void	revise(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback) Deprecated.
void	revise(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRule	revise(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRule	update(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule) Deprecated.
void	update(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback) Deprecated.
void	update(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
FirewallRule	update(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
FirewallRule create(java.lang.String sectionId,
                                FirewallRule firewallRule,
                                java.lang.String id,
                                java.lang.String operation)

Deprecated.

Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale content to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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

Parameters:

sectionId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

Returns:

com.vmware.nsx.model.FirewallRule

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

create

@Deprecated
FirewallRule create(java.lang.String sectionId,
                                FirewallRule firewallRule,
                                java.lang.String id,
                                java.lang.String operation,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale content to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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:

sectionId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRule

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

create

@Deprecated
void create(java.lang.String sectionId,
                        FirewallRule firewallRule,
                        java.lang.String id,
                        java.lang.String operation,
                        com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback)

Deprecated.

Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale content to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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

Invocation Result:
com.vmware.nsx.model.FirewallRule

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

Parameters:

sectionId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

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

create

@Deprecated
void create(java.lang.String sectionId,
                        FirewallRule firewallRule,
                        java.lang.String id,
                        java.lang.String operation,
                        com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale content to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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.model.FirewallRule

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

Parameters:

sectionId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

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

invocationConfig - Configuration for the method invocation.

createmultiple

@Deprecated
FirewallRuleList createmultiple(java.lang.String sectionId,
                                            FirewallRuleList firewallRuleList,
                                            java.lang.String id,
                                            java.lang.String operation)

Deprecated.

Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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

Parameters:

sectionId - (required)

firewallRuleList - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

Returns:

com.vmware.nsx.model.FirewallRuleList

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

createmultiple

@Deprecated
FirewallRuleList createmultiple(java.lang.String sectionId,
                                            FirewallRuleList firewallRuleList,
                                            java.lang.String id,
                                            java.lang.String operation,
                                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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:

sectionId - (required)

firewallRuleList - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRuleList

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

createmultiple

@Deprecated
void createmultiple(java.lang.String sectionId,
                                FirewallRuleList firewallRuleList,
                                java.lang.String id,
                                java.lang.String operation,
                                com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleList> asyncCallback)

Deprecated.

Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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

Invocation Result:
com.vmware.nsx.model.FirewallRuleList

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

Parameters:

sectionId - (required)

firewallRuleList - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

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

createmultiple

@Deprecated
void createmultiple(java.lang.String sectionId,
                                FirewallRuleList firewallRuleList,
                                java.lang.String id,
                                java.lang.String operation,
                                com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleList> asyncCallback,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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.model.FirewallRuleList

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

Parameters:

sectionId - (required)

firewallRuleList - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String sectionId,
                        java.lang.String ruleId)

Deprecated.

Delete existing firewall rule in a firewall section. Deleting firewall rule in a section modifies parent section and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
DELETE /policy/api/v1/infra/domains//security-policies//rules/

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

Parameters:

sectionId - (required)

ruleId - (required)

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

delete

@Deprecated
void delete(java.lang.String sectionId,
                        java.lang.String ruleId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Delete existing firewall rule in a firewall section. Deleting firewall rule in a section modifies parent section and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
DELETE /policy/api/v1/infra/domains//security-policies//rules/

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:

sectionId - (required)

ruleId - (required)

invocationConfig - Configuration for the method invocation.

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

delete

@Deprecated
void delete(java.lang.String sectionId,
                        java.lang.String ruleId,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Delete existing firewall rule in a firewall section. Deleting firewall rule in a section modifies parent section and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
DELETE /policy/api/v1/infra/domains//security-policies//rules/

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

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

Parameters:

sectionId - (required)

ruleId - (required)

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

delete

@Deprecated
void delete(java.lang.String sectionId,
                        java.lang.String ruleId,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Delete existing firewall rule in a firewall section. Deleting firewall rule in a section modifies parent section and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
DELETE /policy/api/v1/infra/domains//security-policies//rules/

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

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

Parameters:

sectionId - (required)

ruleId - (required)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
FirewallRule get(java.lang.String sectionId,
                             java.lang.String ruleId)

Deprecated.

Return existing firewall rule information in a firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules/

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

Parameters:

sectionId - (required)

ruleId - (required)

Returns:

com.vmware.nsx.model.FirewallRule

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

@Deprecated
FirewallRule get(java.lang.String sectionId,
                             java.lang.String ruleId,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Return existing firewall rule information in a firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules/

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:

sectionId - (required)

ruleId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRule

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

@Deprecated
void get(java.lang.String sectionId,
                     java.lang.String ruleId,
                     com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback)

Deprecated.

Return existing firewall rule information in a firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules/

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

Invocation Result:
com.vmware.nsx.model.FirewallRule

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

Parameters:

sectionId - (required)

ruleId - (required)

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

get

@Deprecated
void get(java.lang.String sectionId,
                     java.lang.String ruleId,
                     com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Return existing firewall rule information in a firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules/

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.model.FirewallRule

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

Parameters:

sectionId - (required)

ruleId - (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
FirewallRuleListResult list(java.lang.String sectionId,
                                        java.lang.String appliedTos,
                                        java.lang.String contextProfiles,
                                        java.lang.String cursor,
                                        java.lang.Boolean deepSearch,
                                        java.lang.String destinations,
                                        java.lang.String extendedSources,
                                        java.lang.String filterType,
                                        java.lang.String includedFields,
                                        java.lang.Long pageSize,
                                        java.lang.Boolean searchInvalidReferences,
                                        java.lang.String services,
                                        java.lang.Boolean sortAscending,
                                        java.lang.String sortBy,
                                        java.lang.String sources)

Deprecated.

Return all firewall rule(s) information for a given firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies/

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

Parameters:

sectionId - (required)

appliedTos - AppliedTo's referenced by this section or section's Distributed Service Rules . (optional)

contextProfiles - Limits results to sections having rules with specific Context Profiles. (optional)

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

deepSearch - Toggle to search with direct or indirect references. (optional, default to false)

destinations - Destinations referenced by this section's Distributed Service Rules . (optional)

extendedSources - Limits results to sections having rules with specific Extended Sources. (optional)

filterType - Filter type (optional, default to FILTER)

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)

searchInvalidReferences - Return invalid references in results. (optional, default to false)

services - NSService referenced by this section's Distributed Service Rules . (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

sources - Sources referenced by this section's Distributed Service Rules . (optional)

Returns:

com.vmware.nsx.model.FirewallRuleListResult

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

@Deprecated
FirewallRuleListResult list(java.lang.String sectionId,
                                        java.lang.String appliedTos,
                                        java.lang.String contextProfiles,
                                        java.lang.String cursor,
                                        java.lang.Boolean deepSearch,
                                        java.lang.String destinations,
                                        java.lang.String extendedSources,
                                        java.lang.String filterType,
                                        java.lang.String includedFields,
                                        java.lang.Long pageSize,
                                        java.lang.Boolean searchInvalidReferences,
                                        java.lang.String services,
                                        java.lang.Boolean sortAscending,
                                        java.lang.String sortBy,
                                        java.lang.String sources,
                                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Return all firewall rule(s) information for a given firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies/

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:

sectionId - (required)

appliedTos - AppliedTo's referenced by this section or section's Distributed Service Rules . (optional)

contextProfiles - Limits results to sections having rules with specific Context Profiles. (optional)

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

deepSearch - Toggle to search with direct or indirect references. (optional, default to false)

destinations - Destinations referenced by this section's Distributed Service Rules . (optional)

extendedSources - Limits results to sections having rules with specific Extended Sources. (optional)

filterType - Filter type (optional, default to FILTER)

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)

searchInvalidReferences - Return invalid references in results. (optional, default to false)

services - NSService referenced by this section's Distributed Service Rules . (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

sources - Sources referenced by this section's Distributed Service Rules . (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRuleListResult

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

@Deprecated
void list(java.lang.String sectionId,
                      java.lang.String appliedTos,
                      java.lang.String contextProfiles,
                      java.lang.String cursor,
                      java.lang.Boolean deepSearch,
                      java.lang.String destinations,
                      java.lang.String extendedSources,
                      java.lang.String filterType,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.Boolean searchInvalidReferences,
                      java.lang.String services,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      java.lang.String sources,
                      com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleListResult> asyncCallback)

Deprecated.

Return all firewall rule(s) information for a given firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies/

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

Invocation Result:
com.vmware.nsx.model.FirewallRuleListResult

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

Parameters:

sectionId - (required)

appliedTos - AppliedTo's referenced by this section or section's Distributed Service Rules . (optional)

contextProfiles - Limits results to sections having rules with specific Context Profiles. (optional)

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

deepSearch - Toggle to search with direct or indirect references. (optional, default to false)

destinations - Destinations referenced by this section's Distributed Service Rules . (optional)

extendedSources - Limits results to sections having rules with specific Extended Sources. (optional)

filterType - Filter type (optional, default to FILTER)

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)

searchInvalidReferences - Return invalid references in results. (optional, default to false)

services - NSService referenced by this section's Distributed Service Rules . (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

sources - Sources referenced by this section's Distributed Service Rules . (optional)

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

list

@Deprecated
void list(java.lang.String sectionId,
                      java.lang.String appliedTos,
                      java.lang.String contextProfiles,
                      java.lang.String cursor,
                      java.lang.Boolean deepSearch,
                      java.lang.String destinations,
                      java.lang.String extendedSources,
                      java.lang.String filterType,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.Boolean searchInvalidReferences,
                      java.lang.String services,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      java.lang.String sources,
                      com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleListResult> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Return all firewall rule(s) information for a given firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies/

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.model.FirewallRuleListResult

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

Parameters:

sectionId - (required)

appliedTos - AppliedTo's referenced by this section or section's Distributed Service Rules . (optional)

contextProfiles - Limits results to sections having rules with specific Context Profiles. (optional)

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

deepSearch - Toggle to search with direct or indirect references. (optional, default to false)

destinations - Destinations referenced by this section's Distributed Service Rules . (optional)

extendedSources - Limits results to sections having rules with specific Extended Sources. (optional)

filterType - Filter type (optional, default to FILTER)

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)

searchInvalidReferences - Return invalid references in results. (optional, default to false)

services - NSService referenced by this section's Distributed Service Rules . (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

sources - Sources referenced by this section's Distributed Service Rules . (optional)

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

invocationConfig - Configuration for the method invocation.

revise

@Deprecated
FirewallRule revise(java.lang.String sectionId,
                                java.lang.String ruleId,
                                FirewallRule firewallRule,
                                java.lang.String id,
                                java.lang.String operation)

Deprecated.

Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
POST /policy/api/v1/infra/domains//security-policies//rules/?action=revise

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

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

Returns:

com.vmware.nsx.model.FirewallRule

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

revise

@Deprecated
FirewallRule revise(java.lang.String sectionId,
                                java.lang.String ruleId,
                                FirewallRule firewallRule,
                                java.lang.String id,
                                java.lang.String operation,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
POST /policy/api/v1/infra/domains//security-policies//rules/?action=revise

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:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRule

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

revise

@Deprecated
void revise(java.lang.String sectionId,
                        java.lang.String ruleId,
                        FirewallRule firewallRule,
                        java.lang.String id,
                        java.lang.String operation,
                        com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback)

Deprecated.

Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
POST /policy/api/v1/infra/domains//security-policies//rules/?action=revise

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

Invocation Result:
com.vmware.nsx.model.FirewallRule

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

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

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

revise

@Deprecated
void revise(java.lang.String sectionId,
                        java.lang.String ruleId,
                        FirewallRule firewallRule,
                        java.lang.String id,
                        java.lang.String operation,
                        com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
POST /policy/api/v1/infra/domains//security-policies//rules/?action=revise

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.model.FirewallRule

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

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

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

invocationConfig - Configuration for the method invocation.

update

@Deprecated
FirewallRule update(java.lang.String sectionId,
                                java.lang.String ruleId,
                                FirewallRule firewallRule)

Deprecated.

Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies//rules/

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

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

Returns:

com.vmware.nsx.model.FirewallRule

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

update

@Deprecated
FirewallRule update(java.lang.String sectionId,
                                java.lang.String ruleId,
                                FirewallRule firewallRule,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies//rules/

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:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRule

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

update

@Deprecated
void update(java.lang.String sectionId,
                        java.lang.String ruleId,
                        FirewallRule firewallRule,
                        com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback)

Deprecated.

Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies//rules/

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

Invocation Result:
com.vmware.nsx.model.FirewallRule

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

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

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

update

@Deprecated
void update(java.lang.String sectionId,
                        java.lang.String ruleId,
                        FirewallRule firewallRule,
                        com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies//rules/

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.model.FirewallRule

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

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

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

invocationConfig - Configuration for the method invocation.