com.vmware.nsx_policy.infra.segments package¶
Submodules¶
com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client module¶
-
class
com.vmware.nsx_policy.infra.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
(segment_id, binding_id)¶ Read DHCP static binding state
Parameters: - 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 UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- segment_id (
-
-
class
com.vmware.nsx_policy.infra.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.segments.inter_site_forwarder_client module¶
-
class
com.vmware.nsx_policy.infra.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
(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 infra segment cross site forwarder placement and HA statuss.
Parameters: - 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 UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- segment_id (
-
-
class
com.vmware.nsx_policy.infra.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
(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 infra segment cross site traffic statistics.
Parameters: - 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 UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- segment_id (
-
-
class
com.vmware.nsx_policy.infra.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.segments.ports_client module¶
-
class
com.vmware.nsx_policy.infra.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
(infra_segment_id, infra_port_id, port_monitoring_profile_binding_map_id)¶ API will delete Infra Port Monitoring Profile Binding Profile.
Parameters: - infra_segment_id (
str
) – Infra Segment ID (required) - infra_port_id (
str
) – Infra 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 UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- infra_segment_id (
-
get
(infra_segment_id, infra_port_id, port_monitoring_profile_binding_map_id)¶ API will get Infra Port Monitoring Profile Binding Map.
Parameters: - infra_segment_id (
str
) – Infra Segment ID (required) - infra_port_id (
str
) – Infra 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 UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- infra_segment_id (
-
list
(infra_segment_id, infra_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 Infra Port Monitoring Profile Binding Maps in current port id.
Parameters: - infra_segment_id (
str
) – (required) - infra_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 UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- infra_segment_id (
-
patch
(infra_segment_id, infra_port_id, port_monitoring_profile_binding_map_id, port_monitoring_profile_binding_map)¶ API will create Infra Port Monitoring Profile Binding Map.
Parameters: - infra_segment_id (
str
) – Infra Segment ID (required) - infra_port_id (
str
) – Infra 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 UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- infra_segment_id (
-
update
(infra_segment_id, infra_port_id, port_monitoring_profile_binding_map_id, port_monitoring_profile_binding_map)¶ API will update Infra Port Monitoring Profile Binding Map.
Parameters: - infra_segment_id (
str
) – InfraSegment ID (required) - infra_port_id (
str
) – Infra 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 UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- infra_segment_id (
-
-
class
com.vmware.nsx_policy.infra.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
(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 infra segment port statistics information.
Parameters: - 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 UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequest
Bad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerError
Internal Server ErrorRaise: com.vmware.vapi.std.errors_client.Unauthorized
ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound
Not Found- segments_id (
-
-
class
com.vmware.nsx_policy.infra.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