com.vmware.nsx_policy.global_infra.domains package¶

Subpackages¶

Submodules¶

com.vmware.nsx_policy.global_infra.domains.communication_maps_client module¶

class com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

REVISE_OPERATION_AFTER = 'insert_after'¶: Possible value for operation of method CommunicationEntries.revise().

REVISE_OPERATION_BEFORE = 'insert_before'¶: Possible value for operation of method CommunicationEntries.revise().

REVISE_OPERATION_BOTTOM = 'insert_bottom'¶: Possible value for operation of method CommunicationEntries.revise().

REVISE_OPERATION_TOP = 'insert_top'¶: Possible value for operation of method CommunicationEntries.revise().

delete(domain_id, communication_map_id, communication_entry_id)¶

Delete CommunicationEntry This API is deprecated. Please use the following API instead. DELETE /infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, communication_map_id, communication_entry_id)¶

Read CommunicationEntry This API is deprecated. Please use the following API instead. GET /infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationEntry`
Returns:	com.vmware.nsx_policy.model.CommunicationEntry
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, communication_map_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List CommunicationEntries This API is deprecated. Please use the following API instead. GET /infra/domains/domain-id/security-policies/security-policy-id/rules

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationEntryListResult`
Returns:	com.vmware.nsx_policy.model.CommunicationEntryListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, communication_map_id, communication_entry_id, communication_entry)¶

Patch the CommunicationEntry. If a communication entry for the given communication-entry-id is not present, the object will get created and if it is present it will be updated. This is a full replace This API is deprecated. Please use the following API instead. PATCH /infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required) communication_entry (`com.vmware.nsx_policy.model_client.CommunicationEntry`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

revise(domain_id, communication_map_id, communication_entry_id, communication_entry, anchor_path=None, operation=None)¶

This is used to re-order a communictation entry within a communication map. This API is deprecated. Please use the following API instead. POST /infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id?action=revise

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required) communication_entry (`com.vmware.nsx_policy.model_client.CommunicationEntry`) – (required) anchor_path (`str` or `None`) – The communication map/communication entry path if operation is ‘insert_after’ or ‘insert_before’ (optional) operation (`str` or `None`) – Operation (optional, default to insert_top)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationEntry`
Returns:	com.vmware.nsx_policy.model.CommunicationEntry
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, communication_map_id, communication_entry_id, communication_entry)¶

Update the CommunicationEntry. If a CommunicationEntry with the communication-entry-id is not already present, this API fails with a 404. Creation of CommunicationEntries is not allowed using this API. This API is deprecated. Please use the following API instead PUT /infra/domains/domain-id/security-policies/securit-policy-id/rules/rule-id

Parameters:	domain_id (`str`) – (required) communication_map_id (`str`) – (required) communication_entry_id (`str`) – (required) communication_entry (`com.vmware.nsx_policy.model_client.CommunicationEntry`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.CommunicationEntry`
Returns:	com.vmware.nsx_policy.model.CommunicationEntry
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.communication_maps_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters:	stub_config (`vmware.vapi.bindings.stub.StubConfiguration`) – Stub config instance

com.vmware.nsx_policy.global_infra.domains.gateway_policies_client module¶

class com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

REVISE_OPERATION_AFTER = 'insert_after'¶: Possible value for operation of method Rules.revise().

REVISE_OPERATION_BEFORE = 'insert_before'¶: Possible value for operation of method Rules.revise().

REVISE_OPERATION_BOTTOM = 'insert_bottom'¶: Possible value for operation of method Rules.revise().

REVISE_OPERATION_TOP = 'insert_top'¶: Possible value for operation of method Rules.revise().

delete(domain_id, gateway_policy_id, rule_id)¶

Delete rule

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) rule_id (`str`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, gateway_policy_id, rule_id)¶

Read rule

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) rule_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Rule`
Returns:	com.vmware.nsx_policy.model.Rule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, gateway_policy_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List rules

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.RuleListResult`
Returns:	com.vmware.nsx_policy.model.RuleListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, gateway_policy_id, rule_id, rule)¶

Update the gateway rule. Create new rule if a rule with the rule-id is not already present.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) rule_id (`str`) – (required) rule (`com.vmware.nsx_policy.model_client.Rule`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

revise(domain_id, gateway_policy_id, rule_id, rule, anchor_path=None, operation=None)¶

This is used to re-order a gateway rule within a gateway policy.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) rule_id (`str`) – (required) rule (`com.vmware.nsx_policy.model_client.Rule`) – (required) anchor_path (`str` or `None`) – The security policy/rule path if operation is ‘insert_after’ or ‘insert_before’ (optional) operation (`str` or `None`) – Operation (optional, default to insert_top)
Return type:	`com.vmware.nsx_policy.model_client.Rule`
Returns:	com.vmware.nsx_policy.model.Rule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, gateway_policy_id, rule_id, rule)¶

Update the gateway rule. Create new rule if a rule with the rule-id is not already present.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) rule_id (`str`) – (required) rule (`com.vmware.nsx_policy.model_client.Rule`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Rule`
Returns:	com.vmware.nsx_policy.model.Rule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Statistics(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

list(domain_id, gateway_policy_id, enforcement_point_path=None)¶

Get statistics of a gateay policy. - no enforcement point path specified: Stats will be evaluated on each enforcement. point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point.

Parameters:	domain_id (`str`) – (required) gateway_policy_id (`str`) – (required) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional)
Return type:	`com.vmware.nsx_policy.model_client.SecurityPolicyStatisticsListResult`
Returns:	com.vmware.nsx_policy.model.SecurityPolicyStatisticsListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters:	stub_config (`vmware.vapi.bindings.stub.StubConfiguration`) – Stub config instance

com.vmware.nsx_policy.global_infra.domains.groups_client module¶

class com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

CREATE_ACTION_ADD = 'add'¶: Possible value for action of method ExternalIdExpressions.create().

CREATE_ACTION_REMOVE = 'remove'¶: Possible value for action of method ExternalIdExpressions.create().

create(domain_id, group_id, expression_id, group_member_list, action)¶

It will add or remove the specified members having external ID for a given expression of a group.

Parameters:	domain_id (`str`) – (required) group_id (`str`) – (required) expression_id (`str`) – (required) group_member_list (`com.vmware.nsx_policy.model_client.GroupMemberList`) – (required) action (`str`) – Add or Remove group members. (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

delete(domain_id, group_id, expression_id)¶

Delete Group External ID Expression

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) expression_id (`str`) – ExternalIDExpression ID (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, group_id, expression_id, external_id_expression)¶

If a group ExternalIDexpression with the expression-id is not already present, create a new ExternalIDexpresison. If it already exists, replace the existing ExternalIDexpression.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) expression_id (`str`) – ExternalIDExpression ID (required) external_id_expression (`com.vmware.nsx_policy.model_client.ExternalIDExpression`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

delete(domain_id, group_id, group_monitoring_profile_binding_map_id)¶

API will delete Group Monitoring Profile Binding

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) group_monitoring_profile_binding_map_id (`str`) – Group Monitoring Profile Binding Map ID (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, group_id, group_monitoring_profile_binding_map_id)¶

API will get Group Monitoring Profile Binding Map

Parameters:	domain_id (`str`) – Domain-ID (required) group_id (`str`) – Group ID (required) group_monitoring_profile_binding_map_id (`str`) – Group Monitoring Profile Binding Map ID (required)
Return type:	`com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.GroupMonitoringProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, group_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all Group Monitoring Profile Binding Maps in current group id.

Parameters:	domain_id (`str`) – (required) group_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMapListResult`
Returns:	com.vmware.nsx_policy.model.GroupMonitoringProfileBindingMapListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, group_id, group_monitoring_profile_binding_map_id, group_monitoring_profile_binding_map)¶

API will create group monitoring profile binding map

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) group_monitoring_profile_binding_map_id (`str`) – Group Monitoring Profile Binding Map ID (required) group_monitoring_profile_binding_map (`com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, group_id, group_monitoring_profile_binding_map_id, group_monitoring_profile_binding_map)¶

API will update Group Monitoring Profile Binding Map

Parameters:	domain_id (`str`) – DomainID (required) group_id (`str`) – Group ID (required) group_monitoring_profile_binding_map_id (`str`) – Group Monitoring Profile Binding Map ID (required) group_monitoring_profile_binding_map (`com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap`
Returns:	com.vmware.nsx_policy.model.GroupMonitoringProfileBindingMap
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

CREATE_ACTION_ADD = 'add'¶: Possible value for action of method IpAddressExpressions.create().

CREATE_ACTION_REMOVE = 'remove'¶: Possible value for action of method IpAddressExpressions.create().

create(domain_id, group_id, expression_id, ip_address_list, action)¶

It will add or remove the specified IP Addresses from a given expression of a group.

Parameters:	domain_id (`str`) – (required) group_id (`str`) – (required) expression_id (`str`) – (required) ip_address_list (`com.vmware.nsx_policy.model_client.IPAddressList`) – (required) action (`str`) – Add or Remove group members. (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

delete(domain_id, group_id, expression_id)¶

Delete Group IPAddressExpression

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) expression_id (`str`) – IPAddressExpression ID (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, group_id, expression_id, ip_address_expression)¶

If a group IPAddressExpression with the expression-id is not already present, create a new IPAddressExpression. If it already exists, replace the existing IPAddressExpression.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) expression_id (`str`) – IPAddressExpression ID (required) ip_address_expression (`com.vmware.nsx_policy.model_client.IPAddressExpression`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

CREATE_ACTION_ADD = 'add'¶: Possible value for action of method MacAddressExpressions.create().

CREATE_ACTION_REMOVE = 'remove'¶: Possible value for action of method MacAddressExpressions.create().

create(domain_id, group_id, expression_id, m_ac_address_list, action)¶

It will add or remove the specified MAC Addresses from a given expression of a group.

Parameters:	domain_id (`str`) – (required) group_id (`str`) – (required) expression_id (`str`) – (required) m_ac_address_list (`com.vmware.nsx_policy.model_client.MACAddressList`) – (required) action (`str`) – Add or Remove group members. (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

delete(domain_id, group_id, expression_id)¶

Delete Group MACAddressExpression

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) expression_id (`str`) – MACAddressExpression ID (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, group_id, expression_id, m_ac_address_expression)¶

If a group MACAddressExpression with the expression-id is not already present, create a new MACAddressExpression. If it already exists, replace the existing MACAddressExpression.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) expression_id (`str`) – MACAddressExpression ID (required) m_ac_address_expression (`com.vmware.nsx_policy.model_client.MACAddressExpression`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.groups_client.MemberTypes(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

get(domain_id, group_id)¶

It retrieves member types for a given group. In case of nested groups, it calculates member types of child groups as well. Considers member type for members added via static members and dynamic membership criteria.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required)
Return type:	`com.vmware.nsx_policy.model_client.GroupMemberTypeListResult`
Returns:	com.vmware.nsx_policy.model.GroupMemberTypeListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

CREATE_ACTION_ADD = 'add'¶: Possible value for action of method PathExpressions.create().

CREATE_ACTION_REMOVE = 'remove'¶: Possible value for action of method PathExpressions.create().

create(domain_id, group_id, expression_id, group_member_list, action)¶

It will add or remove the specified members having path for a given expression of a group.

Parameters:	domain_id (`str`) – (required) group_id (`str`) – (required) expression_id (`str`) – (required) group_member_list (`com.vmware.nsx_policy.model_client.GroupMemberList`) – (required) action (`str`) – Add or Remove group members. (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

delete(domain_id, group_id, expression_id)¶

Delete Group Path Expression

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) expression_id (`str`) – PathExpression ID (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, group_id, expression_id, path_expression)¶

If a group path_expression with the expression-id is not already present, create a new pathexpresison. If it already exists, replace the existing pathexpression.

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) expression_id (`str`) – PathExpression ID (required) path_expression (`com.vmware.nsx_policy.model_client.PathExpression`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.groups_client.PortMirroringInstances(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

delete(domain_id, group_id, port_mirroring_instance_id)¶

API will delete port mirroring instance. Mirroring from source to destination ports will be stopped. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) port_mirroring_instance_id (`str`) – Port Mirroring Instance Id (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, group_id, port_mirroring_instance_id)¶

API will return details of port mirroring instance. If instance does not exist, it will return 404. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) port_mirroring_instance_id (`str`) – Port Mirroring Instance Id (required)
Return type:	`com.vmware.nsx_policy.model_client.PortMirroringInstance`
Returns:	com.vmware.nsx_policy.model.PortMirroringInstance
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, group_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

API will list all port mirroring instances active on current group. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.PortMirroringInstanceListResult`
Returns:	com.vmware.nsx_policy.model.PortMirroringInstanceListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, group_id, port_mirroring_instance_id, port_mirroring_instance)¶

Create a new Port Mirroring Instance if the Port Mirroring Instance with given id does not already exist. If the Port Mirroring Instance with the given id already exists, patch with the existing Port Mirroring Instance. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) port_mirroring_instance_id (`str`) – Port Mirroring Instance Id (required) port_mirroring_instance (`com.vmware.nsx_policy.model_client.PortMirroringInstance`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, group_id, port_mirroring_instance_id, port_mirroring_instance)¶

Create or Replace port mirroring instance. Packets will be mirrored from source group to destination group. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/port-mirroring-profiles

Parameters:	domain_id (`str`) – Domain ID (required) group_id (`str`) – Group ID (required) port_mirroring_instance_id (`str`) – Port Mirroring Instance Id (required) port_mirroring_instance (`com.vmware.nsx_policy.model_client.PortMirroringInstance`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.PortMirroringInstance`
Returns:	com.vmware.nsx_policy.model.PortMirroringInstance
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.groups_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters:	stub_config (`vmware.vapi.bindings.stub.StubConfiguration`) – Stub config instance

class com.vmware.nsx_policy.global_infra.domains.groups_client.Tags(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

get(domain_id, group_id)¶

Get tags used to define conditions inside a Group. Also includes tags inside nested groups.

Parameters:	domain_id (`str`) – Domain id (required) group_id (`str`) – Group Id (required)
Return type:	`com.vmware.nsx_policy.model_client.GroupTagsList`
Returns:	com.vmware.nsx_policy.model.GroupTagsList
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client module¶

class com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

REVISE_OPERATION_AFTER = 'insert_after'¶: Possible value for operation of method Rules.revise().

REVISE_OPERATION_BEFORE = 'insert_before'¶: Possible value for operation of method Rules.revise().

REVISE_OPERATION_BOTTOM = 'insert_bottom'¶: Possible value for operation of method Rules.revise().

REVISE_OPERATION_TOP = 'insert_top'¶: Possible value for operation of method Rules.revise().

delete(domain_id, policy_id, rule_id)¶

Delete intrusion detection rule.

Parameters:	domain_id (`str`) – Domain ID (required) policy_id (`str`) – Policy ID (required) rule_id (`str`) – Rule ID (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, policy_id, rule_id)¶

Read intrusion detection rule

Parameters:	domain_id (`str`) – Domain ID (required) policy_id (`str`) – Policy ID (required) rule_id (`str`) – Rule ID (required)
Return type:	`com.vmware.nsx_policy.model_client.IdsRule`
Returns:	com.vmware.nsx_policy.model.IdsRule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, policy_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List intrusion detection rules.

Parameters:	domain_id (`str`) – Domain ID (required) policy_id (`str`) – Policy ID (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.IdsRuleListResult`
Returns:	com.vmware.nsx_policy.model.IdsRuleListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, policy_id, rule_id, ids_rule)¶

Patch intrusion detection system rule.

Parameters:	domain_id (`str`) – Domain ID (required) policy_id (`str`) – Policy ID (required) rule_id (`str`) – Rule ID (required) ids_rule (`com.vmware.nsx_policy.model_client.IdsRule`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

revise(domain_id, policy_id, rule_id, ids_rule, anchor_path=None, operation=None)¶

This is used to re-order a rule within a security policy.

Parameters:	domain_id (`str`) – (required) policy_id (`str`) – (required) rule_id (`str`) – (required) ids_rule (`com.vmware.nsx_policy.model_client.IdsRule`) – (required) anchor_path (`str` or `None`) – The security policy/rule path if operation is ‘insert_after’ or ‘insert_before’ (optional) operation (`str` or `None`) – Operation (optional, default to insert_top)
Return type:	`com.vmware.nsx_policy.model_client.IdsRule`
Returns:	com.vmware.nsx_policy.model.IdsRule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, policy_id, rule_id, ids_rule)¶

Update intrusion detection system rule.

Parameters:	domain_id (`str`) – Domain ID (required) policy_id (`str`) – Policy ID (required) rule_id (`str`) – Rule ID (required) ids_rule (`com.vmware.nsx_policy.model_client.IdsRule`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.IdsRule`
Returns:	com.vmware.nsx_policy.model.IdsRule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters:	stub_config (`vmware.vapi.bindings.stub.StubConfiguration`) – Stub config instance

com.vmware.nsx_policy.global_infra.domains.security_policies_client module¶

class com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

REVISE_OPERATION_AFTER = 'insert_after'¶: Possible value for operation of method Rules.revise().

REVISE_OPERATION_BEFORE = 'insert_before'¶: Possible value for operation of method Rules.revise().

REVISE_OPERATION_BOTTOM = 'insert_bottom'¶: Possible value for operation of method Rules.revise().

REVISE_OPERATION_TOP = 'insert_top'¶: Possible value for operation of method Rules.revise().

delete(domain_id, security_policy_id, rule_id)¶

Delete rule

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required) rule_id (`str`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

get(domain_id, security_policy_id, rule_id)¶

Read rule

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required) rule_id (`str`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Rule`
Returns:	com.vmware.nsx_policy.model.Rule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

list(domain_id, security_policy_id, cursor=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶

List rules

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required) cursor (`str` or `None`) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) include_mark_for_delete_objects (`bool` or `None`) – Include objects that are marked for deletion in results (optional, default to false) included_fields (`str` or `None`) – Comma separated list of fields that should be included in query result (optional) page_size (`long` or `None`) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) sort_ascending (`bool` or `None`) – (optional) sort_by (`str` or `None`) – Field by which records are sorted (optional)
Return type:	`com.vmware.nsx_policy.model_client.RuleListResult`
Returns:	com.vmware.nsx_policy.model.RuleListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

patch(domain_id, security_policy_id, rule_id, rule)¶

Patch the rule. If Rule corresponding to the the given rule-id is not present, the object will get created and if it is present it will be updated. This is a full replace

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required) rule_id (`str`) – (required) rule (`com.vmware.nsx_policy.model_client.Rule`) – (required)
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

revise(domain_id, security_policy_id, rule_id, rule, anchor_path=None, operation=None)¶

This is used to re-order a rule within a security policy.

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required) rule_id (`str`) – (required) rule (`com.vmware.nsx_policy.model_client.Rule`) – (required) anchor_path (`str` or `None`) – The security policy/rule path if operation is ‘insert_after’ or ‘insert_before’ (optional) operation (`str` or `None`) – Operation (optional, default to insert_top)
Return type:	`com.vmware.nsx_policy.model_client.Rule`
Returns:	com.vmware.nsx_policy.model.Rule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

update(domain_id, security_policy_id, rule_id, rule)¶

Update the rule. Create new rule if a rule with the rule-id is not already present.

Parameters:	domain_id (`str`) – (required) security_policy_id (`str`) – (required) rule_id (`str`) – (required) rule (`com.vmware.nsx_policy.model_client.Rule`) – (required)
Return type:	`com.vmware.nsx_policy.model_client.Rule`
Returns:	com.vmware.nsx_policy.model.Rule
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.security_policies_client.Statistics(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters:	config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

list(domain_id, security_policy_id, enforcement_point_path=None)¶

Get statistics of a security policy. - no enforcement point path specified: Stats will be evaluated on each enforcement point. - {enforcement_point_path}: Stats are evaluated only on the given enforcement point.

Parameters:	domain_id (`str`) – Domain id (required) security_policy_id (`str`) – Security policy id (required) enforcement_point_path (`str` or `None`) – String Path of the enforcement point (optional)
Return type:	`com.vmware.nsx_policy.model_client.SecurityPolicyStatisticsListResult`
Returns:	com.vmware.nsx_policy.model.SecurityPolicyStatisticsListResult
Raise:	`com.vmware.vapi.std.errors_client.ServiceUnavailable` Service Unavailable
Raise:	`com.vmware.vapi.std.errors_client.InvalidRequest` Bad Request, Precondition Failed
Raise:	`com.vmware.vapi.std.errors_client.InternalServerError` Internal Server Error
Raise:	`com.vmware.vapi.std.errors_client.Unauthorized` Forbidden
Raise:	`com.vmware.vapi.std.errors_client.NotFound` Not Found

class com.vmware.nsx_policy.global_infra.domains.security_policies_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters:	stub_config (`vmware.vapi.bindings.stub.StubConfiguration`) – Stub config instance