2018-08-07 19:42:25 -04:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2020-06-05 18:48:31 -04:00
< title > com.vmware.nsx.dhcp package — NSX-T SDK 2.5.1.0.5 documentation< / title >
2018-08-07 19:42:25 -04:00
2019-05-29 14:05:24 -04:00
< script type = "text/javascript" src = "_static/js/modernizr.min.js" > < / script >
2018-08-07 19:42:25 -04:00
2019-05-29 14:05:24 -04: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 >
2019-05-29 14:05:24 -04:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
2018-08-07 19:42:25 -04:00
2019-05-29 14:05:24 -04:00
2018-08-07 19:42:25 -04:00
2019-05-29 14:05:24 -04:00
2018-11-01 14:01:54 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
2018-08-07 19:42:25 -04:00
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2020-01-27 14:28:46 -05:00
< link rel = "next" title = "com.vmware.nsx.dhcp.servers package" href = "com.vmware.nsx.dhcp.servers.html" / >
< link rel = "prev" title = "com.vmware.nsx.configs package" href = "com.vmware.nsx.configs.html" / >
2018-08-07 19:42:25 -04: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" >
2019-05-29 14:05:24 -04:00
< div class = "wy-side-nav-search" >
2018-08-07 19:42:25 -04:00
2018-11-01 14:01:54 -04:00
< a href = "index.html" class = "icon icon-home" > NSX-T SDK
2018-08-07 19:42:25 -04:00
< / a >
< div class = "version" >
2020-06-05 18:48:31 -04:00
2.5.1.0.5
2018-08-07 19:42:25 -04: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 >
< 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 >
2018-11-01 14:01:54 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.nsx_client" > com.vmware.nsx_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-client-for-vmc-module" > com.vmware.nsx_client_for_vmc module< / a > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / 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 >
2018-11-01 14:01:54 -04:00
< a href = "index.html" > NSX-T SDK< / a >
2018-08-07 19:42:25 -04:00
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
2018-11-01 14:01:54 -04:00
< li > < a href = "com.vmware.nsx.html" > com.vmware.nsx package< / a > » < / li >
2018-08-07 19:42:25 -04:00
2018-11-01 14:01:54 -04:00
< li > com.vmware.nsx.dhcp package< / li >
2018-08-07 19:42:25 -04:00
< li class = "wy-breadcrumbs-aside" >
2018-11-01 14:01:54 -04:00
< a href = "_sources/com.vmware.nsx.dhcp.rst.txt" rel = "nofollow" > View page source< / a >
2018-08-07 19:42:25 -04:00
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx.dhcp" >
< span id = "com-vmware-nsx-dhcp-package" > < / span > < h1 > com.vmware.nsx.dhcp package< a class = "headerlink" href = "#module-com.vmware.nsx.dhcp" title = "Permalink to this headline" > ¶< / a > < / h1 >
2020-01-27 14:28:46 -05:00
< div class = "section" id = "subpackages" >
< h2 > Subpackages< a class = "headerlink" href = "#subpackages" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx.dhcp.servers.html" > com.vmware.nsx.dhcp.servers package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx.dhcp.servers.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx.dhcp.servers.html#module-com.vmware.nsx.dhcp.servers.ip_pools_client" > com.vmware.nsx.dhcp.servers.ip_pools_client module< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx.dhcp.servers.html#module-com.vmware.nsx.dhcp.servers.static_bindings_client" > com.vmware.nsx.dhcp.servers.static_bindings_client module< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
2018-08-07 19:42:25 -04:00
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx.dhcp.servers_client" >
< span id = "com-vmware-nsx-dhcp-servers-client-module" > < / span > < h2 > com.vmware.nsx.dhcp.servers_client module< a class = "headerlink" href = "#module-com.vmware.nsx.dhcp.servers_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.IpPools" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx.dhcp.servers_client.< / code > < code class = "sig-name descname" > IpPools< / 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.dhcp.servers_client.IpPools" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2019-05-29 14:05:24 -04:00
< 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" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.IpPools.create" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > create< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > dhcp_ip_pool< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.IpPools.create" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create an ip pool for a local DHCP server< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > dhcp_ip_pool< / strong > (< a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpIpPool" title = "com.vmware.nsx.model_client.DhcpIpPool" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpIpPool< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpIpPool" title = "com.vmware.nsx.model_client.DhcpIpPool" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpIpPool< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpIpPool< / 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.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.IpPools.delete" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > pool_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.IpPools.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete a specific ip pool of a given logical DHCP server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > pool_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04: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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.IpPools.get" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > pool_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.IpPools.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Return a specific ip pool of a given logical DHCP server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > pool_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpIpPool" title = "com.vmware.nsx.model_client.DhcpIpPool" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpIpPool< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpIpPool< / 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.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.IpPools.list" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_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" > 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.dhcp.servers_client.IpPools.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > List the ip pools of a logical DHCP server with pagination support.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_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 > 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 >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpIpPoolListResult" title = "com.vmware.nsx.model_client.DhcpIpPoolListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpIpPoolListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpIpPoolListResult< / 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.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.IpPools.update" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > pool_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > dhcp_ip_pool< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.IpPools.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Update a specific ip pool of a given logical DHCP server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > pool_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > dhcp_ip_pool< / strong > (< a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpIpPool" title = "com.vmware.nsx.model_client.DhcpIpPool" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpIpPool< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpIpPool" title = "com.vmware.nsx.model_client.DhcpIpPool" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpIpPool< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpIpPool< / 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.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.Leases" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx.dhcp.servers_client.< / code > < code class = "sig-name descname" > Leases< / 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.dhcp.servers_client.Leases" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2019-05-29 14:05:24 -04:00
< 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 attribute" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.Leases.GET_SOURCE_CACHED" >
2020-01-27 14:28:46 -05:00
< code class = "sig-name descname" > GET_SOURCE_CACHED< / code > < em class = "property" > = 'cached'< / em > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.Leases.GET_SOURCE_CACHED" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-11-01 14:01:54 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > source< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx.dhcp.servers_client.Leases.get" title = "com.vmware.nsx.dhcp.servers_client.Leases.get" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Leases.get()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py attribute" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.Leases.GET_SOURCE_REALTIME" >
2020-01-27 14:28:46 -05:00
< code class = "sig-name descname" > GET_SOURCE_REALTIME< / code > < em class = "property" > = 'realtime'< / em > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.Leases.GET_SOURCE_REALTIME" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-11-01 14:01:54 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > source< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx.dhcp.servers_client.Leases.get" title = "com.vmware.nsx.dhcp.servers_client.Leases.get" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Leases.get()< / span > < / code > < / a > .< / p >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx.dhcp.servers_client.Leases.delete" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > ip< / span > < / em > , < em class = "sig-param" > < span class = "n" > mac< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.Leases.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete a single DHCP lease entry specified by ip and mac. The DHCP
server matches the DHCP lease with the given ip address and the mac
address. The matched lease entry will be deleted. If no lease matches,
the request is ignored. The DHCP lease to be deleted will be removed by
the system from both active and standby node. The system will report
error if the DHCP lease could not be removed from both nodes. If the
DHCP lease could not be removed on either node, please check the DHCP
server status. Once the DHCP server status is UP, please invoke the
deletion API again to ensure the lease gets deleted from both nodes.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > ip< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > mac< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< / 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" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.Leases.get" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > address< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > pool_id< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > source< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.Leases.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get specific leases of a given dhcp server. As a dhcp server could
manage millions of leases, the API has to limit the number of the
returned leases via two mutually-excluded request parameters, i.e.
“pool_id” and “address”. Either a “pool_id” or an “address” can
be provided, but not both in a same call. If a “pool_id” is
specified, the leases of the specific pool are returned. If an
“address” is specified, only the lease(s) represented y this address
is(are) returned. The “address” can be a single IP, an ip-range, or a
mac address.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > address< / 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 >
< li > < p > < strong > pool_id< / 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 >
< li > < p > < strong > source< / 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 >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpLeases" title = "com.vmware.nsx.model_client.DhcpLeases" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpLeases< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpLeases< / 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.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2018-11-01 14:01:54 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx.dhcp.servers_client.State" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx.dhcp.servers_client.< / code > < code class = "sig-name descname" > State< / 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.dhcp.servers_client.State" 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-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx.dhcp.servers_client.State.get" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > barrier_id< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > request_id< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.State.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Return realized state information of a dhcp server. After a dhcp server
is created or updated, you can invoke this API to get the realization
information of the server.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > barrier_id< / 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 > ) – < / p > < / li >
< li > < p > < strong > request_id< / 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 >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.ConfigurationState" title = "com.vmware.nsx.model_client.ConfigurationState" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.ConfigurationState< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.ConfigurationState< / 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.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 >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.StaticBindings" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx.dhcp.servers_client.< / code > < code class = "sig-name descname" > StaticBindings< / 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.dhcp.servers_client.StaticBindings" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-11-01 14:01:54 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2019-05-29 14:05:24 -04:00
< 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" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.StaticBindings.create" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > create< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > dhcp_static_binding< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.StaticBindings.create" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create a static binding for a logical DHCP server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > dhcp_static_binding< / strong > (< a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpStaticBinding" title = "com.vmware.nsx.model_client.DhcpStaticBinding" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpStaticBinding< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpStaticBinding" title = "com.vmware.nsx.model_client.DhcpStaticBinding" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpStaticBinding< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpStaticBinding< / 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.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.StaticBindings.delete" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > binding_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.StaticBindings.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete a specific static binding of a given logical DHCP server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > binding_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04: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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.StaticBindings.get" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > binding_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.StaticBindings.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Return a specific static binding of a given logical DHCP server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > binding_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpStaticBinding" title = "com.vmware.nsx.model_client.DhcpStaticBinding" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpStaticBinding< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpStaticBinding< / 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.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.StaticBindings.list" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_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" > 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.dhcp.servers_client.StaticBindings.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Return a paginated list of a static bindings of a given logical DHCP
server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_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 > 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 >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpStaticBindingListResult" title = "com.vmware.nsx.model_client.DhcpStaticBindingListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpStaticBindingListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpStaticBindingListResult< / 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.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.StaticBindings.update" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > binding_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > dhcp_static_binding< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.StaticBindings.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Update a specific static binding of a given local DHCP server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > binding_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > dhcp_static_binding< / strong > (< a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpStaticBinding" title = "com.vmware.nsx.model_client.DhcpStaticBinding" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpStaticBinding< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpStaticBinding" title = "com.vmware.nsx.model_client.DhcpStaticBinding" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpStaticBinding< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpStaticBinding< / 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.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04: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.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04: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.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2018-11-01 14:01:54 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.Statistics" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx.dhcp.servers_client.< / code > < code class = "sig-name descname" > Statistics< / 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.dhcp.servers_client.Statistics" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-11-01 14:01:54 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2019-05-29 14:05:24 -04:00
< 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" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.Statistics.get" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.Statistics.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-11-01 14:01:54 -04:00
< dd > < p > Returns the statistics of the given dhcp server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p >
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpStatistics" title = "com.vmware.nsx.model_client.DhcpStatistics" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpStatistics< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpStatistics< / 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.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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2018-11-01 14:01:54 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.Status" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx.dhcp.servers_client.< / code > < code class = "sig-name descname" > Status< / 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.dhcp.servers_client.Status" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-11-01 14:01:54 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2019-05-29 14:05:24 -04:00
< 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" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.Status.get" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > server_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx.dhcp.servers_client.Status.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-11-01 14:01:54 -04:00
< dd > < p > Returns the service status of the given dhcp server.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > server_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p >
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx.html#com.vmware.nsx.model_client.DhcpServerStatus" title = "com.vmware.nsx.model_client.DhcpServerStatus" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx.model_client.DhcpServerStatus< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx.model.DhcpServerStatus< / 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.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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx.dhcp.servers_client.StubFactory" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx.dhcp.servers_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.dhcp.servers_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< p > Initialize StubFactoryBase< / p >
2019-05-29 14:05:24 -04:00
< 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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2020-01-27 14:28:46 -05:00
< a href = "com.vmware.nsx.dhcp.servers.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx.dhcp.servers package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2018-08-07 19:42:25 -04:00
2020-01-27 14:28:46 -05:00
< a href = "com.vmware.nsx.configs.html" class = "btn btn-neutral float-left" title = "com.vmware.nsx.configs package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2018-08-07 19:42:25 -04:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2020-01-27 14:28:46 -05:00
© Copyright 2020, VMware, Inc.
2018-08-07 19:42:25 -04:00
< / p >
< / div >
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 > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
2018-11-01 14:01:54 -04:00
SphinxRtdTheme.Navigation.enable(true);
2018-08-07 19:42:25 -04:00
});
2019-05-29 14:05:24 -04:00
< / script >
2018-08-07 19:42:25 -04:00
< / body >
< / html >
