Avi CustomIpamDnsProfile Object API

##CLI## ``` - configure customipamdnsprofile - show customipamdnsprofile ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /customipamdnsprofile
  2. post /customipamdnsprofile
  3. delete /customipamdnsprofile/{uuid}
  4. get /customipamdnsprofile/{uuid}
  5. patch /customipamdnsprofile/{uuid}
  6. put /customipamdnsprofile/{uuid}
Up
get /customipamdnsprofile
( customipamdnsprofileGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

CustomIpamDnsProfileApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "script_params" : [ {
      "is_sensitive" : true,
      "is_dynamic" : true,
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "script_uri" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CustomIpamDnsProfileApiResponse

401

log in failed

Up
post /customipamdnsprofile
( customipamdnsprofilePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — CustomIpamDnsProfile object creation

Return type

CustomIpamDnsProfile

Example data

Content-Type: application/json
{
  "script_params" : [ {
    "is_sensitive" : true,
    "is_dynamic" : true,
    "name" : "aeiou",
    "value" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "script_uri" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CustomIpamDnsProfile

401

log in failed

Up
delete /customipamdnsprofile/{uuid}
( customipamdnsprofileUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /customipamdnsprofile/{uuid}
( customipamdnsprofileUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

CustomIpamDnsProfile

Example data

Content-Type: application/json
{
  "script_params" : [ {
    "is_sensitive" : true,
    "is_dynamic" : true,
    "name" : "aeiou",
    "value" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "script_uri" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CustomIpamDnsProfile

401

log in failed

Up
patch /customipamdnsprofile/{uuid}
( customipamdnsprofileUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — CustomIpamDnsProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

CustomIpamDnsProfile

Example data

Content-Type: application/json
{
  "script_params" : [ {
    "is_sensitive" : true,
    "is_dynamic" : true,
    "name" : "aeiou",
    "value" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "script_uri" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CustomIpamDnsProfile

401

log in failed

Up
put /customipamdnsprofile/{uuid}
( customipamdnsprofileUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — CustomIpamDnsProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

CustomIpamDnsProfile

Example data

Content-Type: application/json
{
  "script_params" : [ {
    "is_sensitive" : true,
    "is_dynamic" : true,
    "name" : "aeiou",
    "value" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "script_uri" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK CustomIpamDnsProfile

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. CustomIpamDnsProfile
  2. CustomIpamDnsProfileApiResponse
  3. CustomParams

CustomIpamDnsProfile Up

name
String Name of the Custom IPAM DNS Profile. Field introduced in 17.1.1.
script_params (optional)
array[CustomParams] Parameters that are always passed to the IPAM/DNS script. Field introduced in 17.1.1.
script_uri
String Script URI of form controller //ipamdnsscripts/<file-name>. Field introduced in 17.1.1.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 17.1.1.
url (optional)
String url
uuid (optional)
String Field introduced in 17.1.1.

CustomIpamDnsProfileApiResponse Up

count
Integer format: int32
results

CustomParams Up

is_dynamic (optional)
Boolean Placeholder for description of property is_dynamic of obj type CustomParams field type str type boolean
is_sensitive (optional)
Boolean Placeholder for description of property is_sensitive of obj type CustomParams field type str type boolean
name
String Name of the object.
value (optional)
String value of CustomParams.