com.vmware.nsx_policy.infra package

Subpackages

Submodules

com.vmware.nsx_policy.infra.domains_client module

class com.vmware.nsx_policy.infra.domains_client.CommunicationMaps(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 CommunicationMaps.revise().

REVISE_OPERATION_BEFORE = 'insert_before'

Possible value for operation of method CommunicationMaps.revise().

REVISE_OPERATION_BOTTOM = 'insert_bottom'

Possible value for operation of method CommunicationMaps.revise().

REVISE_OPERATION_TOP = 'insert_top'

Possible value for operation of method CommunicationMaps.revise().

delete(domain_id, communication_map_id)

Deletes the communication map along with all the communication entries

Parameters

  • domain_id (str) – (required)

  • communication_map_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)

Read communication-map for a domain.

Parameters

  • domain_id (str) – (required)

  • communication_map_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.CommunicationMap

Returns

com.vmware.nsx_policy.model.CommunicationMap

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, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

List all communication maps for a domain.

Parameters

  • domain_id (str) – (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • 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.CommunicationMapListResult

Returns

com.vmware.nsx_policy.model.CommunicationMapListResult

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_map)

Patch the communication map for a domain.

Parameters
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_map, anchor_path=None, operation=None)

This is used to set a precedence of a communication map w.r.t others.

Parameters

  • domain_id (str) – (required)

  • communication_map_id (str) – (required)

  • communication_map (com.vmware.nsx_policy.model_client.CommunicationMap) – (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.CommunicationMap

Returns

com.vmware.nsx_policy.model.CommunicationMap

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_map)

Create or Update the communication map for a domain. This is a full replace. All the CommunicationEntries are replaced.

Parameters
Return type

com.vmware.nsx_policy.model_client.CommunicationMap

Returns

com.vmware.nsx_policy.model.CommunicationMap

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.infra.domains_client.GatewayPolicies(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, gateway_policy_id)

Read gateway policy for a domain.

Parameters

  • domain_id (str) – (required)

  • gateway_policy_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.GatewayPolicy

Returns

com.vmware.nsx_policy.model.GatewayPolicy

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(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

List all gateway policies across all domains ordered by precedence.

Parameters

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • 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.GatewayPolicyListResult

Returns

com.vmware.nsx_policy.model.GatewayPolicyListResult

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, gateway_policy)

Update the gateway policy for a domain. This is a full replace. All the rules are replaced.

Parameters
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, gateway_policy)

Update the gateway policy for a domain. This is a full replace. All the rules are replaced.

Parameters
Return type

com.vmware.nsx_policy.model_client.GatewayPolicy

Returns

com.vmware.nsx_policy.model.GatewayPolicy

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.infra.domains_client.Groups(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, force=None)

Delete Group

Parameters

  • domain_id (str) – Domain ID (required)

  • group_id (str) – Group ID (required)

  • force (bool or None) – Force delete the resource even if it is being used somewhere (optional, default to false)

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)

Read group

Parameters

  • domain_id (str) – Domain ID (required)

  • group_id (str) – Group ID (required)

Return type

com.vmware.nsx_policy.model_client.Group

Returns

com.vmware.nsx_policy.model.Group

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, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

List Groups for a domain

Parameters

  • domain_id (str) – Domain ID (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • 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.GroupListResult

Returns

com.vmware.nsx_policy.model.GroupListResult

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)

If a group with the group-id is not already present, create a new group. If it already exists, patch the group.

Parameters
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)

If a group with the group-id is not already present, create a new group. If it already exists, update the group.

Parameters
Return type

com.vmware.nsx_policy.model_client.Group

Returns

com.vmware.nsx_policy.model.Group

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.infra.domains_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.infra.realized_state_client module

class com.vmware.nsx_policy.infra.realized_state_client.RealizedEntities(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

list(intent_path)

Get list of realized objects associated with intent object

Parameters

intent_path (str) – String Path of the intent object (required)

Return type

com.vmware.nsx_policy.model_client.GenericPolicyRealizedResourceListResult

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResourceListResult

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.infra.realized_state_client.RealizedEntity(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(realized_path=None)

Get realized entity uniquely identified by realized path

Parameters

realized_path (str or None) – String Path of the realized object (optional)

Return type

com.vmware.nsx_policy.model_client.GenericPolicyRealizedResource

Returns

com.vmware.nsx_policy.model.GenericPolicyRealizedResource

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

refresh(intent_path, enforcement_point_path=None)

Refresh the status and statistics of all realized entities associated with given intent path synchronously.

Parameters

  • intent_path (str) – String Path of the intent object (required)

  • enforcement_point_path (str or None) – String Path of the enforcement point (optional)

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.infra.realized_state_client.Status(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(intent_path)

Get consolidated status of an intent object, specified by path in query parameter

Parameters

intent_path (str) – String Path of the intent object (required)

Return type

com.vmware.nsx_policy.model_client.ConsolidatedRealizedStatus

Returns

com.vmware.nsx_policy.model.ConsolidatedRealizedStatus

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.infra.realized_state_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.infra.realized_state_client.VirtualMachines(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

list(enforcement_point_path, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

This API filters objects of type virtual machine. This API also gives some VM details such as VM name, IDs and the current state of the VMs.

Parameters

  • enforcement_point_path (str) – String Path of the enforcement point (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • 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.VirtualMachineListResult

Returns

com.vmware.nsx_policy.model.VirtualMachineListResult

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.infra.services_client module

class com.vmware.nsx_policy.infra.services_client.ServiceEntries(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(service_id, service_entry_id)

Delete Service entry

Parameters

  • service_id (str) – Service ID (required)

  • service_entry_id (str) – Service entry 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(service_id, service_entry_id)

Service entry

Parameters

  • service_id (str) – Service ID (required)

  • service_entry_id (str) – Service entry ID (required)

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx_policy.model.ServiceEntry The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.ServiceEntry.

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(service_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of Service entries for the given service

Parameters

  • service_id (str) – Service ID (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • 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.ServiceEntryListResult

Returns

com.vmware.nsx_policy.model.ServiceEntryListResult

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(service_id, service_entry_id, service_entry)

If a service entry with the service-entry-id is not already present, create a new service entry. If it already exists, patch the service entry.

Parameters

  • service_id (str) – Service ID (required)

  • service_entry_id (str) – Service entry ID (required)

  • service_entry (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx_policy.model_client.ServiceEntry.

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(service_id, service_entry_id, service_entry)

If a service entry with the service-entry-id is not already present, create a new service entry. If it already exists, update the service entry.

Parameters

  • service_id (str) – Service ID (required)

  • service_entry_id (str) – Service entry ID (required)

  • service_entry (vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined in com.vmware.nsx_policy.model_client.ServiceEntry.

Return type

vmware.vapi.struct.VapiStruct

Returns

com.vmware.nsx_policy.model.ServiceEntry The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.ServiceEntry.

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.infra.services_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.infra.tier_0s_client module

class com.vmware.nsx_policy.infra.tier_0s_client.Groups(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(tier0_id, group_id)

Delete the Group under Tier-0.

Parameters

  • tier0_id (str) – (required)

  • group_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(tier0_id, group_id)

Read Tier-0 Group

Parameters

  • tier0_id (str) – (required)

  • group_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.Group

Returns

com.vmware.nsx_policy.model.Group

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(tier0_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of all Groups for Tier-0.

Parameters

  • tier0_id (str) – (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • 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.GroupListResult

Returns

com.vmware.nsx_policy.model.GroupListResult

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(tier0_id, group_id, group)

If a Group with the group-id is not already present, create a new Group under the tier0-id. Update if exists. The API valiates that Tier-0 is present before creating the Group.

Parameters
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(tier0_id, group_id, group)

If a Group with the group-id is not already present, create a new Group under the tier0-id. Update if exists. The API valiates that Tier-0 is present before creating the Group.

Parameters
Return type

com.vmware.nsx_policy.model_client.Group

Returns

com.vmware.nsx_policy.model.Group

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.infra.tier_0s_client.RoutingTable(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

LIST_ROUTE_SOURCE_BGP = 'BGP'

Possible value for routeSource of method RoutingTable.list().

LIST_ROUTE_SOURCE_CONNECTED = 'CONNECTED'

Possible value for routeSource of method RoutingTable.list().

LIST_ROUTE_SOURCE_STATIC = 'STATIC'

Possible value for routeSource of method RoutingTable.list().

list(tier0_id, cursor=None, edge_id=None, enforcement_point_path=None, included_fields=None, page_size=None, route_source=None, sort_ascending=None, sort_by=None)

Get routing table from tier-0

Parameters

  • tier0_id (str) – (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • edge_id (str or None) – UUID of edge node (optional)

  • enforcement_point_path (str or None) – String Path of the enforcement point (optional)

  • 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)

  • route_source (str or None) – Filter routes based on the source from which route is learned (optional)

  • 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.RoutingTableListResult

Returns

com.vmware.nsx_policy.model.RoutingTableListResult

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.infra.tier_0s_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.infra.tier_1s_client module

class com.vmware.nsx_policy.infra.tier_1s_client.DnsForwarder(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(tier1_id)

Delete DNS configuration for tier-1 instance

Parameters

tier1_id (str) – Tier-1 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(tier1_id)

Read the DNS Forwarder for the given tier-1 instance

Parameters

tier1_id (str) – Tier-1 ID (required)

Return type

com.vmware.nsx_policy.model_client.PolicyDnsForwarder

Returns

com.vmware.nsx_policy.model.PolicyDnsForwarder

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(tier1_id, policy_dns_forwarder)

Update the DNS Forwarder

Parameters
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(tier1_id, policy_dns_forwarder)

Update the DNS Forwarder

Parameters
Return type

com.vmware.nsx_policy.model_client.PolicyDnsForwarder

Returns

com.vmware.nsx_policy.model.PolicyDnsForwarder

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.infra.tier_1s_client.IpfixSwitchCollectionInstances(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(tier1_id, ipfix_switch_collection_instance_id)

API deletes IPFIX Switch Collection Instance.Flow forwarding to selected collector will be stopped.

Parameters

  • tier1_id (str) – Tier-1 ID (required)

  • ipfix_switch_collection_instance_id (str) – IPFIX Switch Collection 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(tier1_id, ipfix_switch_collection_instance_id)

API will return details of IPFIX switch collection. If instance does not exist, it will return 404.

Parameters

  • tier1_id (str) – Tier-1 ID (required)

  • ipfix_switch_collection_instance_id (str) – IPFIX switch collection id (required)

Return type

com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance

Returns

com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstance

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(tier1_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

API provides list IPFIX Switch collection instances available on selected logical switch.

Parameters

  • tier1_id (str) – Tier-1 ID (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • 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.IPFIXSwitchCollectionInstanceListResult

Returns

com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstanceListResult

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(tier1_id, ipfix_switch_collection_instance_id, i_pfix_switch_collection_instance)

Create a new IPFIX switch collection instance if the IPFIX switch collection instance with given id does not already exist. If the IPFIX switch collection instance with the given id already exists, patch with the existing IPFIX switch collection instance.

Parameters
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(tier1_id, ipfix_switch_collection_instance_id, i_pfix_switch_collection_instance)

Create or replace IPFIX switch collection instance. Instance will start forwarding data to provided IPFIX collector.

Parameters
Return type

com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance

Returns

com.vmware.nsx_policy.model.IPFIXSwitchCollectionInstance

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.infra.tier_1s_client.Segments(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

delete(tier1_id, segment_id)

Delete segment

Parameters

  • tier1_id (str) – Tier-1 ID (required)

  • segment_id (str) – Segment 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(tier1_id, segment_id)

Read segment

Parameters

  • tier1_id (str) – Tier-1 ID (required)

  • segment_id (str) – Segment ID (required)

Return type

com.vmware.nsx_policy.model_client.Segment

Returns

com.vmware.nsx_policy.model.Segment

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(tier1_id, cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Paginated list of all segments under tier-1 instance

Parameters

  • tier1_id (str) – Tier-1 ID (required)

  • cursor (str or None) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

  • 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.SegmentListResult

Returns

com.vmware.nsx_policy.model.SegmentListResult

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(tier1_id, segment_id, segment)

If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes.

Parameters
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(tier1_id, segment_id, segment)

If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object.

Parameters
Return type

com.vmware.nsx_policy.model_client.Segment

Returns

com.vmware.nsx_policy.model.Segment

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.infra.tier_1s_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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