com.vmware.nsx_policy.global_infra.tier_1s.segments package¶
Submodules¶
com.vmware.nsx_policy.global_infra.tier_1s.segments.dhcp_static_bindings_client module¶
-
class
com.vmware.nsx_policy.global_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
- 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.global_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.global_infra.tier_1s.segments.inter_site_forwarder_client module¶
-
class
com.vmware.nsx_policy.global_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
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)edge_path (
str
orNone
) – Policy path of edge node (optional)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)include_mark_for_delete_objects (
bool
orNone
) – Include objects that are marked for deletion in results (optional, default to false)included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional)page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)sort_ascending (
bool
orNone
) – (optional)sort_by (
str
orNone
) – 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.global_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
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)edge_path (
str
orNone
) – Policy path of edge node (optional)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)include_mark_for_delete_objects (
bool
orNone
) – Include objects that are marked for deletion in results (optional, default to false)included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional)page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)sort_ascending (
bool
orNone
) – (optional)sort_by (
str
orNone
) – 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.global_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.global_infra.tier_1s.segments.ports_client module¶
-
class
com.vmware.nsx_policy.global_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
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)include_mark_for_delete_objects (
bool
orNone
) – Include objects that are marked for deletion in results (optional, default to false)included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional)page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)sort_ascending (
bool
orNone
) – (optional)sort_by (
str
orNone
) – 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.global_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
orNone
) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)edge_path (
str
orNone
) – Policy path of edge node (optional)enforcement_point_path (
str
orNone
) – String Path of the enforcement point (optional)include_mark_for_delete_objects (
bool
orNone
) – Include objects that are marked for deletion in results (optional, default to false)included_fields (
str
orNone
) – Comma separated list of fields that should be included in query result (optional)page_size (
long
orNone
) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)sort_ascending (
bool
orNone
) – (optional)sort_by (
str
orNone
) – Field by which records are sorted (optional)
- Return type
- 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.global_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