2020-01-27 14:28:46 -05:00
<!DOCTYPE html>
2020-09-21 16:47:14 -04:00
< html class = "writer-html5" lang = "en" >
2020-01-27 14:28:46 -05:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2020-09-21 16:47:14 -04:00
< title > com.vmware.nsx_policy.global_infra.sites.enforcement_points package — NSX-T Policy SDK 3.0.2.0.0 documentation< / title >
2020-01-27 14:28:46 -05:00
2020-09-21 16:47:14 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2020-01-27 14:28:46 -05:00
2020-09-21 16:47:14 -04:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2020-01-27 14:28:46 -05:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
2020-06-05 18:48:31 -04:00
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/doctools.js" > < / script >
< script src = "_static/language_data.js" > < / script >
2020-01-27 14:28:46 -05:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2020-09-21 16:47:14 -04:00
< link rel = "next" title = "com.vmware.nsx_policy.global_infra.tags package" href = "com.vmware.nsx_policy.global_infra.tags.html" / >
< link rel = "prev" title = "com.vmware.nsx_policy.global_infra.sites package" href = "com.vmware.nsx_policy.global_infra.sites.html" / >
2020-01-27 14:28:46 -05:00
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
2020-09-21 16:47:14 -04:00
< a href = "index.html" class = "icon icon-home" alt = "Documentation Home" > NSX-T Policy SDK
2020-01-27 14:28:46 -05:00
< / a >
< div class = "version" >
2020-09-21 16:47:14 -04:00
3.0.2.0.0
2020-01-27 14:28:46 -05:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
2020-09-21 16:47:14 -04:00
2020-01-27 14:28:46 -05:00
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Contents:< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "com.html" > com package< / a > < ul class = "current" >
< li class = "toctree-l2 current" > < a class = "reference internal" href = "com.html#subpackages" > Subpackages< / a > < ul class = "current" >
< li class = "toctree-l3 current" > < a class = "reference internal" href = "com.vmware.html" > com.vmware package< / a > < ul class = "current" >
< li class = "toctree-l4 current" > < a class = "reference internal" href = "com.vmware.html#subpackages" > Subpackages< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.nsx_policy_client" > com.vmware.nsx_policy_client module< / a > < / li >
2020-06-05 18:48:31 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#com-vmware-nsx-policy-client-for-vmc-module" > com.vmware.nsx_policy_client_for_vmc module< / a > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
2020-09-21 16:47:14 -04:00
2020-01-27 14:28:46 -05:00
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
2020-09-21 16:47:14 -04:00
< a href = "index.html" > NSX-T Policy SDK< / a >
2020-01-27 14:28:46 -05:00
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
2020-09-21 16:47:14 -04:00
< li > < a href = "index.html" class = "icon icon-home" > < / a > » < / li >
2020-01-27 14:28:46 -05:00
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.html" > com.vmware.nsx_policy package< / a > » < / li >
2020-09-21 16:47:14 -04:00
< li > < a href = "com.vmware.nsx_policy.global_infra.html" > com.vmware.nsx_policy.global_infra package< / a > » < / li >
2020-01-27 14:28:46 -05:00
2020-09-21 16:47:14 -04:00
< li > < a href = "com.vmware.nsx_policy.global_infra.sites.html" > com.vmware.nsx_policy.global_infra.sites package< / a > » < / li >
< li > com.vmware.nsx_policy.global_infra.sites.enforcement_points package< / li >
2020-01-27 14:28:46 -05:00
< li class = "wy-breadcrumbs-aside" >
2020-09-21 16:47:14 -04:00
< a href = "_sources/com.vmware.nsx_policy.global_infra.sites.enforcement_points.rst.txt" rel = "nofollow" > View page source< / a >
2020-01-27 14:28:46 -05:00
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
2020-09-21 16:47:14 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.sites.enforcement_points" >
< span id = "com-vmware-nsx-policy-global-infra-sites-enforcement-points-package" > < / span > < h1 > com.vmware.nsx_policy.global_infra.sites.enforcement_points package< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.sites.enforcement_points" title = "Permalink to this headline" > ¶< / a > < / h1 >
2020-01-27 14:28:46 -05:00
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
2020-09-21 16:47:14 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client" >
< span id = "com-vmware-nsx-policy-global-infra-sites-enforcement-points-edge-clusters-client-module" > < / span > < h2 > com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.EdgeNodes" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.< / code > < code class = "sig-name descname" > EdgeNodes< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.EdgeNodes" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.EdgeNodes.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > site_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > enforcementpoint_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > edge_cluster_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > edge_node_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.EdgeNodes.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read a Edge Node under an Enforcement Point, Edge Cluster< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > site_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > enforcementpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > edge_cluster_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > edge_node_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
2020-09-21 16:47:14 -04:00
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyEdgeNode" title = "com.vmware.nsx_policy.model_client.PolicyEdgeNode" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyEdgeNode< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyEdgeNode< / p >
< / dd >
2020-01-27 14:28:46 -05:00
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.EdgeNodes.list" >
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > site_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > enforcementpoint_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > edge_cluster_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > cursor< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > include_mark_for_delete_objects< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > included_fields< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > page_size< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_ascending< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_by< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.EdgeNodes.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Paginated list of all Edge Nodes under an Enforcement Point, Edge
Cluster< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > site_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > enforcementpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > edge_cluster_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / p > < / li >
< li > < p > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / p > < / li >
< li > < p > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / p > < / li >
< li > < p > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / p > < / li >
< li > < p > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyEdgeNodeListResult" title = "com.vmware.nsx_policy.model_client.PolicyEdgeNodeListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyEdgeNodeListResult< / span > < / code > < / a > < / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyEdgeNodeListResult< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.StubFactory" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.< / code > < code class = "sig-name descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > stub_config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
< p > Initialize StubFactoryBase< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.< / code > < code class = "sig-name descname" > UrlCategorizationConfigs< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > site_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > enforcement_point_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > edge_cluster_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > url_categorization_config_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete PolicyUrlCategorizationConfig. If deleted, the URL
categorization will be disabled for that edge cluster.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > site_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > enforcement_point_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > edge_cluster_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > url_categorization_config_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > site_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > enforcement_point_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > edge_cluster_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > url_categorization_config_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > 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.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > site_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > enforcement_point_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > edge_cluster_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > url_categorization_config_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
2020-09-21 16:47:14 -04:00
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" title = "com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyUrlCategorizationConfig< / p >
< / dd >
2020-01-27 14:28:46 -05:00
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > site_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > enforcement_point_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > edge_cluster_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > url_categorization_config_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > policy_url_categorization_config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > 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.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > site_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > enforcement_point_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > edge_cluster_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > url_categorization_config_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > policy_url_categorization_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" title = "com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig< / span > < / code > < / a > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" title = "com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig< / span > < / code > < / a > < / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyUrlCategorizationConfig< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > site_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > enforcement_point_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > edge_cluster_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > url_categorization_config_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > policy_url_categorization_config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.sites.enforcement_points.edge_clusters_client.UrlCategorizationConfigs.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > 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.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > site_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > enforcement_point_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > edge_cluster_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > url_categorization_config_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > policy_url_categorization_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" title = "com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig< / span > < / code > < / a > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" title = "com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyUrlCategorizationConfig< / span > < / code > < / a > < / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyUrlCategorizationConfig< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2020-09-21 16:47:14 -04:00
< a href = "com.vmware.nsx_policy.global_infra.tags.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx_policy.global_infra.tags package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2020-01-27 14:28:46 -05:00
2020-09-21 16:47:14 -04:00
< a href = "com.vmware.nsx_policy.global_infra.sites.html" class = "btn btn-neutral float-left" title = "com.vmware.nsx_policy.global_infra.sites package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2020-01-27 14:28:46 -05:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2020-09-21 16:47:14 -04:00
2020-01-27 14:28:46 -05:00
© Copyright 2020, VMware, Inc.
< / p >
< / div >
2020-09-21 16:47:14 -04:00
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
2020-01-27 14:28:46 -05:00
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
