com.vmware.nsx_policy.infra.tier_1s.segments package

Submodules

com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client module

class com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client.State(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(tier1_id, segment_id, binding_id)

Read DHCP static binding state

Parameters

  • tier1_id (str) – (required)

  • segment_id (str) – (required)

  • binding_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.DhcpStaticBindingState

Returns

com.vmware.nsx_policy.model.DhcpStaticBindingState

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.segments.dhcp_static_bindings_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.segments.inter_site_forwarder_client module

class com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.SiteSpanInfo(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(tier1_id, segment_id, cursor=None, edge_path=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Get segment cross site forwarder placement and HA statuss.

Parameters

  • tier1_id (str) – (required)

  • segment_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_path (str or None) – Policy path of edge node (optional)

  • enforcement_point_path (str or None) – String Path of the enforcement point (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.SegmentL2ForwarderSiteSpanInfo

Returns

com.vmware.nsx_policy.model.SegmentL2ForwarderSiteSpanInfo

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.segments.inter_site_forwarder_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(tier1_id, segment_id, cursor=None, edge_path=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Get segment cross site traffic statistics.

Parameters

  • tier1_id (str) – (required)

  • segment_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_path (str or None) – Policy path of edge node (optional)

  • enforcement_point_path (str or None) – String Path of the enforcement point (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.SegmentCrossSiteTrafficStats

Returns

com.vmware.nsx_policy.model.SegmentCrossSiteTrafficStats

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.segments.inter_site_forwarder_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.segments.ports_client module

class com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortDiscoveryProfileBindingMaps(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, port_id, port_discovery_profile_binding_map_id)

API will delete Port Discovery Profile Binding Profile

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_discovery_profile_binding_map_id (str) – Port Discovery 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(tier1_id, segment_id, port_id, port_discovery_profile_binding_map_id)

API will get Port Discovery Profile Binding Map

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_discovery_profile_binding_map_id (str) – Port Discovery Profile Binding Map ID (required)

Return type

com.vmware.nsx_policy.model_client.PortDiscoveryProfileBindingMap

Returns

com.vmware.nsx_policy.model.PortDiscoveryProfileBindingMap

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, segment_id, port_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 Discovery Profile Binding Maps in current port id.

Parameters

  • tier1_id (str) – (required)

  • segment_id (str) – (required)

  • port_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.PortDiscoveryProfileBindingMapListResult

Returns

com.vmware.nsx_policy.model.PortDiscoveryProfileBindingMapListResult

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, port_id, port_discovery_profile_binding_map_id, port_discovery_profile_binding_map)

API will create Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_discovery_profile_binding_map_id (str) – Port Discovery Profile Binding Map ID (required)

  • port_discovery_profile_binding_map (com.vmware.nsx_policy.model_client.PortDiscoveryProfileBindingMap) – (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(tier1_id, segment_id, port_id, port_discovery_profile_binding_map_id, port_discovery_profile_binding_map)

API will update Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_discovery_profile_binding_map_id (str) – Port Discovery Profile Binding Map ID (required)

  • port_discovery_profile_binding_map (com.vmware.nsx_policy.model_client.PortDiscoveryProfileBindingMap) – (required)

Return type

com.vmware.nsx_policy.model_client.PortDiscoveryProfileBindingMap

Returns

com.vmware.nsx_policy.model.PortDiscoveryProfileBindingMap

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.segments.ports_client.PortMonitoringProfileBindingMaps(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, port_id, port_monitoring_profile_binding_map_id)

API will delete Port Monitoring Profile Binding Profile.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

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

API will get Port Monitoring Profile Binding Map.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_monitoring_profile_binding_map_id (str) – Port Monitoring Profile Binding Map ID (required)

Return type

com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap

Returns

com.vmware.nsx_policy.model.PortMonitoringProfileBindingMap

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, segment_id, port_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 Monitoring Profile Binding Maps in current port id.

Parameters

  • tier1_id (str) – (required)

  • segment_id (str) – (required)

  • port_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.PortMonitoringProfileBindingMapListResult

Returns

com.vmware.nsx_policy.model.PortMonitoringProfileBindingMapListResult

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, port_id, port_monitoring_profile_binding_map_id, port_monitoring_profile_binding_map)

API will create Port Monitoring Profile Binding Map.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_monitoring_profile_binding_map_id (str) – Port Monitoring Profile Binding Map ID (required)

  • port_monitoring_profile_binding_map (com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap) – (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(tier1_id, segment_id, port_id, port_monitoring_profile_binding_map_id, port_monitoring_profile_binding_map)

API will update Port Monitoring Profile Binding Map.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_monitoring_profile_binding_map_id (str) – Port Monitoring Profile Binding Map ID (required)

  • port_monitoring_profile_binding_map (com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap) – (required)

Return type

com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap

Returns

com.vmware.nsx_policy.model.PortMonitoringProfileBindingMap

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.segments.ports_client.PortQosProfileBindingMaps(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, port_id, port_qos_profile_binding_map_id)

API will delete Port QoS Profile Binding Profile.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_qos_profile_binding_map_id (str) – Port QoS 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(tier1_id, segment_id, port_id, port_qos_profile_binding_map_id)

API will get Port QoS Profile Binding Map.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_qos_profile_binding_map_id (str) – Port QoS Profile Binding Map ID (required)

Return type

com.vmware.nsx_policy.model_client.PortQosProfileBindingMap

Returns

com.vmware.nsx_policy.model.PortQoSProfileBindingMap

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

API will list all Port QoS Profile Binding Maps in current port id.

Parameters

  • tier1_id (str) – (required)

  • segment_id (str) – (required)

  • port_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.PortQosProfileBindingMapListResult

Returns

com.vmware.nsx_policy.model.PortQoSProfileBindingMapListResult

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, port_id, port_qos_profile_binding_map_id, port_qos_profile_binding_map)

API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_qos_profile_binding_map_id (str) – Port QoS Profile Binding Map ID (required)

  • port_qos_profile_binding_map (com.vmware.nsx_policy.model_client.PortQosProfileBindingMap) – (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(tier1_id, segment_id, port_id, port_qos_profile_binding_map_id, port_qos_profile_binding_map)

API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.

Parameters

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

  • segment_id (str) – Segment ID (required)

  • port_id (str) – Port ID (required)

  • port_qos_profile_binding_map_id (str) – Port QoS Profile Binding Map ID (required)

  • port_qos_profile_binding_map (com.vmware.nsx_policy.model_client.PortQosProfileBindingMap) – (required)

Return type

com.vmware.nsx_policy.model_client.PortQosProfileBindingMap

Returns

com.vmware.nsx_policy.model.PortQoSProfileBindingMap

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.segments.ports_client.PortSecurityProfileBindingMaps(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, port_id, port_security_profile_binding_map_id)

API will delete the port security profile binding map.

Parameters

  • tier1_id (str) – tier-1 gateway id (required)

  • segment_id (str) – segment id (required)

  • port_id (str) – port id (required)

  • port_security_profile_binding_map_id (str) – port security 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(tier1_id, segment_id, port_id, port_security_profile_binding_map_id)

API will return details of the port security profile binding map. If the security profile binding map does not exist, it will return 404.

Parameters

  • tier1_id (str) – tier-1 gateway id (required)

  • segment_id (str) – segment id (required)

  • port_id (str) – port id (required)

  • port_security_profile_binding_map_id (str) – port security profile binding map id (required)

Return type

com.vmware.nsx_policy.model_client.PortSecurityProfileBindingMap

Returns

com.vmware.nsx_policy.model.PortSecurityProfileBindingMap

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

API will list all port security profile binding maps.

Parameters

  • tier1_id (str) – tier-1 gateway id (required)

  • segment_id (str) – segment id (required)

  • port_id (str) – port 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.PortSecurityProfileBindingMapListResult

Returns

com.vmware.nsx_policy.model.PortSecurityProfileBindingMapListResult

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, port_id, port_security_profile_binding_map_id, port_security_profile_binding_map)

Create a new port security profile binding map if the given security profile binding map does not exist. Otherwise, patch the existing port security profile binding map. For objects with no binding maps, default profile is applied.

Parameters

  • tier1_id (str) – tier-1 gateway id (required)

  • segment_id (str) – segment id (required)

  • port_id (str) – port id (required)

  • port_security_profile_binding_map_id (str) – port security profile binding map id (required)

  • port_security_profile_binding_map (com.vmware.nsx_policy.model_client.PortSecurityProfileBindingMap) – (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(tier1_id, segment_id, port_id, port_security_profile_binding_map_id, port_security_profile_binding_map)

API will create or replace the port security profile binding map. For objects with no binding maps, default profile is applied.

Parameters

  • tier1_id (str) – tier-1 gateway id (required)

  • segment_id (str) – segment id (required)

  • port_id (str) – port id (required)

  • port_security_profile_binding_map_id (str) – port security profile binding map id (required)

  • port_security_profile_binding_map (com.vmware.nsx_policy.model_client.PortSecurityProfileBindingMap) – (required)

Return type

com.vmware.nsx_policy.model_client.PortSecurityProfileBindingMap

Returns

com.vmware.nsx_policy.model.PortSecurityProfileBindingMap

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.segments.ports_client.Statistics(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Parameters

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

get(tier1_id, segments_id, port_id, cursor=None, edge_path=None, enforcement_point_path=None, include_mark_for_delete_objects=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)

Get tier-1 segment port statistics information.

Parameters

  • tier1_id (str) – (required)

  • segments_id (str) – (required)

  • port_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_path (str or None) – Policy path of edge node (optional)

  • enforcement_point_path (str or None) – String Path of the enforcement point (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.SegmentPortStatistics

Returns

com.vmware.nsx_policy.model.SegmentPortStatistics

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.segments.ports_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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