com.vmware.nsx_policy.infra.sites package¶

Subpackages¶

com.vmware.nsx_policy.infra.sites.enforcement_points package
- Submodules
- com.vmware.nsx_policy.infra.sites.enforcement_points.edge_clusters_client module

Submodules¶

com.vmware.nsx_policy.infra.sites.enforcement_points_client module¶

class com.vmware.nsx_policy.infra.sites.enforcement_points_client.EdgeBridgeProfiles(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

delete(site_id, enforcement_point_id, profile_id)¶

API will delete L2 bridge profile with ID profile-id

Parameters

site_id (str) – site ID (required)
enforcement_point_id (str) – enforcement point ID (required)
profile_id (str) – profile 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(site_id, enforcement_point_id, profile_id)¶

Read L2 bridge profile with ID profile-id

Parameters

site_id (str) – site ID (required)
enforcement_point_id (str) – enforcement point ID (required)
profile_id (str) – profile ID (required)

Return type

com.vmware.nsx_policy.model_client.L2BridgeEndpointProfile

Returns

com.vmware.nsx_policy.model.L2BridgeEndpointProfile

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

List all L2 bridge profiles

Parameters

site_id (str) – site ID (required)
enforcement_point_id (str) – enforcement point 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.L2BridgeEndpointProfileListResult

Returns

com.vmware.nsx_policy.model.L2BridgeEndpointProfileListResult

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(site_id, enforcement_point_id, profile_id, l2_bridge_endpoint_profile)¶

API will create or update L2 bridge profile with ID profile-id. L2 Bridge profile is only allowed under an enforcement-point with path /infra/sites/default/enforcement-points/default.

Parameters

site_id (str) – site ID (required)
enforcement_point_id (str) – enforcement point ID (required)
profile_id (str) – profile ID (required)
l2_bridge_endpoint_profile (com.vmware.nsx_policy.model_client.L2BridgeEndpointProfile) – (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(site_id, enforcement_point_id, profile_id, l2_bridge_endpoint_profile)¶

API will create or update L2 bridge profile with ID profile-id. L2 Bridge profile is only allowed under an enforcement-point with path /infra/sites/default/enforcement-points/default.

Parameters

site_id (str) – site ID (required)
enforcement_point_id (str) – enforcement point ID (required)
profile_id (str) – profile ID (required)
l2_bridge_endpoint_profile (com.vmware.nsx_policy.model_client.L2BridgeEndpointProfile) – (required)

Return type

com.vmware.nsx_policy.model_client.L2BridgeEndpointProfile

Returns

com.vmware.nsx_policy.model.L2BridgeEndpointProfile

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.sites.enforcement_points_client.EdgeClusters(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(site_id, enforcementpoint_id, edge_cluster_id)¶

Read a Edge Cluster under an Enforcement Point

Parameters

site_id (str) – (required)
enforcementpoint_id (str) – (required)
edge_cluster_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.PolicyEdgeCluster

Returns

com.vmware.nsx_policy.model.PolicyEdgeCluster

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

Paginated list of all Edge Clusters under an Enforcement Point

Parameters

site_id (str) – (required)
enforcementpoint_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.PolicyEdgeClusterListResult

Returns

com.vmware.nsx_policy.model.PolicyEdgeClusterListResult

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.sites.enforcement_points_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.sites.enforcement_points_client.TransportZones(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

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

get(site_id, enforcementpoint_id, transport_zone_id)¶

Read a Transport Zone under an Enforcement Point

Parameters

site_id (str) – (required)
enforcementpoint_id (str) – (required)
transport_zone_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.PolicyTransportZone

Returns

com.vmware.nsx_policy.model.PolicyTransportZone

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

Paginated list of all Transport Zones under an Enforcement Point

Parameters

site_id (str) – (required)
enforcementpoint_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.PolicyTransportZoneListResult

Returns

com.vmware.nsx_policy.model.PolicyTransportZoneListResult

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