Skip to content

Learn Git and GitHub without any code!

Using the Hello World guide, you’ll start a branch, write comments, and open a pull request.

Read the guide
  • Watch

    Notifications

  • Fork

    Fork sdk

    If this dialog fails to load, you can visit the fork page directly.

Permalink
18.2.12
Switch branches/tags
Go to file
* updating  for api_guide.tgz release 18.2.12

* updating  for swagger.tgz release 18.2.12

* updating go/models for avi_go_sdk.tgz release 18.2.12

* updated version
2 contributors

Users who have contributed to this file

@khaltore @grastogi23
686 lines (556 sloc) 24 KB
<!doctype html>
<html>
<head>
<title>Avi CustomIpamDnsProfile Object API</title>
<style type="text/css">
body {
font-family: Trebuchet MS, sans-serif;
font-size: 15px;
color: #444;
margin-right: 24px;
}
h1 {
font-size: 25px;
}
h2 {
font-size: 20px;
}
h3 {
font-size: 16px;
font-weight: bold;
}
hr {
height: 1px;
border: 0;
color: #ddd;
background-color: #ddd;
display: none;
}
.app-desc {
clear: both;
margin-left: 20px;
}
.param-name {
width: 100%;
}
.license-info {
margin-left: 20px;
}
.license-url {
margin-left: 20px;
}
.model {
margin: 0 0 0px 20px;
}
.method {
margin-left: 20px;
}
.method-notes {
margin: 10px 0 20px 0;
font-size: 90%;
color: #555;
}
pre {
padding: 10px;
margin-bottom: 2px;
}
.http-method {
text-transform: uppercase;
}
pre.get {
background-color: #0f6ab4;
}
pre.post {
background-color: #10a54a;
}
pre.put {
background-color: #c5862b;
}
pre.delete {
background-color: #a41e22;
}
.huge {
color: #fff;
}
pre.example {
background-color: #f3f3f3;
padding: 10px;
border: 1px solid #ddd;
}
code {
white-space: pre;
}
.nickname {
font-weight: bold;
}
.method-path {
font-size: 1.5em;
background-color: #0f6ab4;
}
.up {
float:right;
}
.parameter {
width: 500px;
}
.param {
width: 500px;
padding: 10px 0 0 20px;
font-weight: bold;
}
.param-desc {
width: 700px;
padding: 0 0 0 20px;
color: #777;
}
.param-type {
font-style: italic;
}
.param-enum-header {
width: 700px;
padding: 0 0 0 60px;
color: #777;
font-weight: bold;
}
.param-enum {
width: 700px;
padding: 0 0 0 80px;
color: #777;
font-style: italic;
}
.field-label {
padding: 0;
margin: 0;
clear: both;
}
.field-items {
padding: 0 0 15px 0;
margin-bottom: 15px;
}
.return-type {
clear: both;
padding-bottom: 10px;
}
.param-header {
font-weight: bold;
}
.method-tags {
text-align: right;
}
.method-tag {
background: none repeat scroll 0% 0% #24A600;
border-radius: 3px;
padding: 2px 10px;
margin: 2px;
color: #FFF;
display: inline-block;
text-decoration: none;
}
</style>
</head>
<body>
<h1>Avi CustomIpamDnsProfile Object API</h1>
<div class="app-desc">CLI ``` - configure customipamdnsprofile <key> - show customipamdnsprofile <key> ``` </div>
<div class="app-desc">More information: <a href="https://avinetworks.com/contact-us">https://avinetworks.com/contact-us</a></div>
<div class="app-desc">Contact Info: <a href="support@avinetworks.com">support@avinetworks.com</a></div>
<div class="app-desc">Version: 18.2.12</div>
<div class="app-desc">BasePath:/api</div>
<div class="license-info">All rights reserved</div>
<div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div>
<h2>Access</h2>
<ol>
<li>HTTP Basic Authentication</li>
</ol>
<h2><a name="__Methods">Methods</a></h2>
[ Jump to <a href="#__Models">Models</a> ]
<h2>Table of Contents </h2>
<div class="method-summary"></div>
<ol>
<li><a href="#customipamdnsprofileGet"><code><span class="http-method">get</span> /customipamdnsprofile</code></a></li>
<li><a href="#customipamdnsprofilePost"><code><span class="http-method">post</span> /customipamdnsprofile</code></a></li>
<li><a href="#customipamdnsprofileUuidDelete"><code><span class="http-method">delete</span> /customipamdnsprofile/{uuid}</code></a></li>
<li><a href="#customipamdnsprofileUuidGet"><code><span class="http-method">get</span> /customipamdnsprofile/{uuid}</code></a></li>
<li><a href="#customipamdnsprofileUuidPatch"><code><span class="http-method">patch</span> /customipamdnsprofile/{uuid}</code></a></li>
<li><a href="#customipamdnsprofileUuidPut"><code><span class="http-method">put</span> /customipamdnsprofile/{uuid}</code></a></li>
</ol>
<div class="method"><a name="customipamdnsprofileGet"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /customipamdnsprofile</code></pre></div>
<div class="method-summary"> (<span class="nickname">customipamdnsprofileGet</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">name (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; object name </div><div class="param">refers_to (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Filter to request all objects that refers to another Avi resource. Its syntax is refers_to&#x3D;&lt;obj_type&gt;:&lt;obj_uuid&gt;. Eg. get all virtual services referring to pool p1 will be refers_to&#x3D;pool:pool_p1_uuid </div><div class="param">referred_by (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by&#x3D;&lt;obj_type&gt;:&lt;obj_uuid&gt;. Eg. get all pools referred_by virtual service vs1 - referred_by&#x3D;virtualservice:vs_vs1_uuid </div><div class="param">fields (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned. </div><div class="param">include_name (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object. </div><div class="param">skip_default (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Default values are not set. </div><div class="param">join_subresources (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; It automatically returns additional dependent resources like runtime. Eg. join_subresources&#x3D;runtime. </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#CustomIpamDnsProfileApiResponse">CustomIpamDnsProfileApiResponse</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"count" : 123,
"results" : [ {
"script_params" : [ {
"is_sensitive" : true,
"is_dynamic" : true,
"name" : "aeiou",
"value" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"script_uri" : "aeiou"
} ]
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
OK
<a href="#CustomIpamDnsProfileApiResponse">CustomIpamDnsProfileApiResponse</a>
<h4 class="field-label">401</h4>
log in failed
<a href="#"></a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="customipamdnsprofilePost"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /customipamdnsprofile</code></pre></div>
<div class="method-summary"> (<span class="nickname">customipamdnsprofilePost</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; CustomIpamDnsProfile object creation </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#CustomIpamDnsProfile">CustomIpamDnsProfile</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"script_params" : [ {
"is_sensitive" : true,
"is_dynamic" : true,
"name" : "aeiou",
"value" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"script_uri" : "aeiou"
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
OK
<a href="#CustomIpamDnsProfile">CustomIpamDnsProfile</a>
<h4 class="field-label">401</h4>
log in failed
<a href="#"></a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="customipamdnsprofileUuidDelete"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /customipamdnsprofile/{uuid}</code></pre></div>
<div class="method-summary"> (<span class="nickname">customipamdnsprofileUuidDelete</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">uuid (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; UUID of the object to fetch </div>
</div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">name (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; object name </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
String
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>"aeiou"</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">204</h4>
object deleted
<a href="#String">String</a>
<h4 class="field-label">404</h4>
not found
<a href="#"></a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="customipamdnsprofileUuidGet"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /customipamdnsprofile/{uuid}</code></pre></div>
<div class="method-summary"> (<span class="nickname">customipamdnsprofileUuidGet</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">uuid (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; UUID of the object to fetch </div>
</div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">name (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; object name </div><div class="param">fields (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned. </div><div class="param">include_name (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object. </div><div class="param">skip_default (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Default values are not set. </div><div class="param">join_subresources (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; It automatically returns additional dependent resources like runtime. Eg. join_subresources&#x3D;runtime. </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#CustomIpamDnsProfile">CustomIpamDnsProfile</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"script_params" : [ {
"is_sensitive" : true,
"is_dynamic" : true,
"name" : "aeiou",
"value" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"script_uri" : "aeiou"
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
OK
<a href="#CustomIpamDnsProfile">CustomIpamDnsProfile</a>
<h4 class="field-label">401</h4>
log in failed
<a href="#"></a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="customipamdnsprofileUuidPatch"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="patch"><code class="huge"><span class="http-method">patch</span> /customipamdnsprofile/{uuid}</code></pre></div>
<div class="method-summary"> (<span class="nickname">customipamdnsprofileUuidPatch</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">uuid (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; UUID of the object to fetch </div>
</div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; CustomIpamDnsProfile object creation </div>
</div> <!-- field-items -->
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">name (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; object name </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#CustomIpamDnsProfile">CustomIpamDnsProfile</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"script_params" : [ {
"is_sensitive" : true,
"is_dynamic" : true,
"name" : "aeiou",
"value" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"script_uri" : "aeiou"
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
OK
<a href="#CustomIpamDnsProfile">CustomIpamDnsProfile</a>
<h4 class="field-label">401</h4>
log in failed
<a href="#"></a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="customipamdnsprofileUuidPut"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="put"><code class="huge"><span class="http-method">put</span> /customipamdnsprofile/{uuid}</code></pre></div>
<div class="method-summary"> (<span class="nickname">customipamdnsprofileUuidPut</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">uuid (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; UUID of the object to fetch </div>
</div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; CustomIpamDnsProfile object creation </div>
</div> <!-- field-items -->
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">name (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; object name </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#CustomIpamDnsProfile">CustomIpamDnsProfile</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"script_params" : [ {
"is_sensitive" : true,
"is_dynamic" : true,
"name" : "aeiou",
"value" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"script_uri" : "aeiou"
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
OK
<a href="#CustomIpamDnsProfile">CustomIpamDnsProfile</a>
<h4 class="field-label">401</h4>
log in failed
<a href="#"></a>
</div> <!-- method -->
<hr/>
<div class="up"><a href="#__Models">Up</a></div>
<h2><a name="__Models">Models</a></h2>
[ Jump to <a href="#__Methods">Methods</a> ]
<h2>Table of Contents</h2>
<ol>
<li><a href="#CustomIpamDnsProfile"><code>CustomIpamDnsProfile</code></a></li>
<li><a href="#CustomIpamDnsProfileApiResponse"><code>CustomIpamDnsProfileApiResponse</code></a></li>
<li><a href="#CustomParams"><code>CustomParams</code></a></li>
</ol>
<div class="model">
<h3 class="field-label"><a name="CustomIpamDnsProfile">CustomIpamDnsProfile</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">_last_modified (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> UNIX time since epoch in microseconds. Units(MICROSECONDS). </div>
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Name of the Custom IPAM DNS Profile. Field introduced in 17.1.1. </div>
<div class="param">script_params (optional)</div><div class="param-desc"><span class="param-type"><a href="#CustomParams">array[CustomParams]</a></span> Parameters that are always passed to the IPAM/DNS script. Field introduced in 17.1.1. </div>
<div class="param">script_uri </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Script URI of form controller //ipamdnsscripts/&lt;file-name&gt;. Field introduced in 17.1.1. </div>
<div class="param">tenant_ref (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> It is a reference to an object of type Tenant. Field introduced in 17.1.1. </div>
<div class="param">url (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> url </div>
<div class="param">uuid (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Field introduced in 17.1.1. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="CustomIpamDnsProfileApiResponse">CustomIpamDnsProfileApiResponse</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">count </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
<div class="param">results </div><div class="param-desc"><span class="param-type"><a href="#CustomIpamDnsProfile">array[CustomIpamDnsProfile]</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3 class="field-label"><a name="CustomParams">CustomParams</a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">is_dynamic (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Placeholder for description of property is_dynamic of obj type CustomParams field type str type boolean </div>
<div class="param">is_sensitive (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Placeholder for description of property is_sensitive of obj type CustomParams field type str type boolean </div>
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Name of the object. </div>
<div class="param">value (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> value of CustomParams. </div>
</div> <!-- field-items -->
</div>
</body>
</html>