com.vmware.nsx_policy.global_infra.sites.enforcement_points package

Submodules

com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client module

class com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.EdgeNodes(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, edge_node_id)

Read a Edge Node under an Enforcement Point, Edge Cluster

Parameters

  • site_id (str) – (required)

  • enforcementpoint_id (str) – (required)

  • edge_cluster_id (str) – (required)

  • edge_node_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.PolicyEdgeNode

Returns

com.vmware.nsx_policy.model.PolicyEdgeNode

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, edge_cluster_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 Nodes under an Enforcement Point, Edge Cluster

Parameters

  • site_id (str) – (required)

  • enforcementpoint_id (str) – (required)

  • edge_cluster_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.PolicyEdgeNodeListResult

Returns

com.vmware.nsx_policy.model.PolicyEdgeNodeListResult

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.sites.enforcement_points.edge_clusters_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.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs(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, edge_cluster_id, url_categorization_config_id)

Delete PolicyUrlCategorizationConfig. If deleted, the URL categorization will be disabled for that edge cluster.

Parameters

  • site_id (str) – (required)

  • enforcement_point_id (str) – (required)

  • edge_cluster_id (str) – (required)

  • url_categorization_config_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(site_id, enforcement_point_id, edge_cluster_id, url_categorization_config_id)

Gets a PolicyUrlCategorizationConfig. This returns the details of the config like whether the URL categorization is enabled or disabled, the id of the context profiles which are used to filter the categories, and the update frequency of the data from the cloud.

Parameters

  • site_id (str) – (required)

  • enforcement_point_id (str) – (required)

  • edge_cluster_id (str) – (required)

  • url_categorization_config_id (str) – (required)

Return type

com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig

Returns

com.vmware.nsx_policy.model.PolicyUrlCategorizationConfig

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, edge_cluster_id, url_categorization_config_id, policy_url_categorization_config)

Creates/Updates a PolicyUrlCategorizationConfig. Creating or updating the PolicyUrlCategorizationConfig will enable or disable URL categorization for the given edge cluster. If the context_profiles field is empty, the edge cluster will detect all the categories of URLs. If context_profiles field has any context profiles, the edge cluster will detect only the categories listed within those context profiles. The context profiles should have attribute type URL_CATEGORY. The update_frequency specifies how frequently in minutes, the edge cluster will get updates about the URL data from the URL categorization cloud service. If the update_frequency is not specified, the default update frequency will be 30 min.

Parameters
Return type

com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig

Returns

com.vmware.nsx_policy.model.PolicyUrlCategorizationConfig

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, edge_cluster_id, url_categorization_config_id, policy_url_categorization_config)

Creates/Updates a PolicyUrlCategorizationConfig. Creating or updating the PolicyUrlCategorizationConfig will enable or disable URL categorization for the given edge cluster. If the context_profiles field is empty, the edge cluster will detect all the categories of URLs. If context_profiles field has any context profiles, the edge cluster will detect only the categories listed within those context profiles. The context profiles should have attribute type URL_CATEGORY. The update_frequency specifies how frequently in minutes, the edge cluster will get updates about the URL data from the URL categorization cloud service. If the update_frequency is not specified, the default update frequency will be 30 min.

Parameters
Return type

com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig

Returns

com.vmware.nsx_policy.model.PolicyUrlCategorizationConfig

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