Avi SecureChannelMapping Object API

CLI ``` - show securechannelmapping ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 22.1.6
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 /securechannelmapping
  2. post /securechannelmapping
  3. delete /securechannelmapping/{uuid}
  4. get /securechannelmapping/{uuid}
  5. patch /securechannelmapping/{uuid}
  6. put /securechannelmapping/{uuid}
Up
get /securechannelmapping
(securechannelmappingGet)

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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SecureChannelMappingApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "metadata" : [ {
      "val" : "aeiou",
      "key" : "aeiou"
    } ],
    "ip" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "pub_key" : "aeiou",
    "local_ip" : "aeiou",
    "marked_for_delete" : true,
    "is_controller" : true,
    "name" : "aeiou",
    "auth_token" : "aeiou",
    "pub_key_pem" : "aeiou",
    "status" : "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 SecureChannelMappingApiResponse

401

log in failed

Up
post /securechannelmapping
(securechannelmappingPost)

Consumes

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

Request body

body (required)
Body Parameter — SecureChannelMapping object creation

Return type

SecureChannelMapping

Example data

Content-Type: application/json
{
  "metadata" : [ {
    "val" : "aeiou",
    "key" : "aeiou"
  } ],
  "ip" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "pub_key" : "aeiou",
  "local_ip" : "aeiou",
  "marked_for_delete" : true,
  "is_controller" : true,
  "name" : "aeiou",
  "auth_token" : "aeiou",
  "pub_key_pem" : "aeiou",
  "status" : "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 SecureChannelMapping

401

log in failed

Up
delete /securechannelmapping/{uuid}
(securechannelmappingUuidDelete)

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 /securechannelmapping/{uuid}
(securechannelmappingUuidGet)

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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SecureChannelMapping

Example data

Content-Type: application/json
{
  "metadata" : [ {
    "val" : "aeiou",
    "key" : "aeiou"
  } ],
  "ip" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "pub_key" : "aeiou",
  "local_ip" : "aeiou",
  "marked_for_delete" : true,
  "is_controller" : true,
  "name" : "aeiou",
  "auth_token" : "aeiou",
  "pub_key_pem" : "aeiou",
  "status" : "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 SecureChannelMapping

401

log in failed

Up
patch /securechannelmapping/{uuid}
(securechannelmappingUuidPatch)

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 — SecureChannelMapping object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

SecureChannelMapping

Example data

Content-Type: application/json
{
  "metadata" : [ {
    "val" : "aeiou",
    "key" : "aeiou"
  } ],
  "ip" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "pub_key" : "aeiou",
  "local_ip" : "aeiou",
  "marked_for_delete" : true,
  "is_controller" : true,
  "name" : "aeiou",
  "auth_token" : "aeiou",
  "pub_key_pem" : "aeiou",
  "status" : "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 SecureChannelMapping

401

log in failed

Up
put /securechannelmapping/{uuid}
(securechannelmappingUuidPut)

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 — SecureChannelMapping object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

SecureChannelMapping

Example data

Content-Type: application/json
{
  "metadata" : [ {
    "val" : "aeiou",
    "key" : "aeiou"
  } ],
  "ip" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "pub_key" : "aeiou",
  "local_ip" : "aeiou",
  "marked_for_delete" : true,
  "is_controller" : true,
  "name" : "aeiou",
  "auth_token" : "aeiou",
  "pub_key_pem" : "aeiou",
  "status" : "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 SecureChannelMapping

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. SecureChannelMapping
  2. SecureChannelMappingApiResponse
  3. SecureChannelMetadata

SecureChannelMapping Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
auth_token (optional)
String Auth_token used for SE authorization. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip (optional)
String IP of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_controller (optional)
Boolean Whether this entry used for controller. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
local_ip (optional)
String Local ip on controller side reserved for SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
marked_for_delete (optional)
Boolean Whether this entry is marked for delete (first step of deletion). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metadata (optional)
array[SecureChannelMetadata] Metadata associated with auth_token. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String Uuid of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pub_key (optional)
String Public key of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pub_key_pem (optional)
String Public key pem of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
status (optional)
String Authorization status of current secure channel. Enum options - SECURE_CHANNEL_NONE, SECURE_CHANNEL_CONNECTED, SECURE_CHANNEL_AUTH_SSH_SUCCESS, SECURE_CHANNEL_AUTH_SSH_FAILED, SECURE_CHANNEL_AUTH_TOKEN_SUCCESS, SECURE_CHANNEL_AUTH_TOKEN_FAILED, SECURE_CHANNEL_AUTH_ERRORS, SECURE_CHANNEL_AUTH_IGNORED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String Uuid of SE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SecureChannelMappingApiResponse Up

count
Integer format: int32
results
next (optional)

SecureChannelMetadata Up

key (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
val (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.