Avi SecureChannelMapping Object API

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

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" : [ {
    "local_ip" : "aeiou",
    "metadata" : [ {
      "val" : "aeiou",
      "key" : "aeiou"
    } ],
    "marked_for_delete" : true,
    "is_controller" : true,
    "ip" : "aeiou",
    "name" : "aeiou",
    "pub_key_pem" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "pub_key" : "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 /securechannel
(securechannelPost)

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
{
  "local_ip" : "aeiou",
  "metadata" : [ {
    "val" : "aeiou",
    "key" : "aeiou"
  } ],
  "marked_for_delete" : true,
  "is_controller" : true,
  "ip" : "aeiou",
  "name" : "aeiou",
  "pub_key_pem" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "pub_key" : "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 /securechannel/{uuid}
(securechannelUuidDelete)

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 /securechannel/{uuid}
(securechannelUuidGet)

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
{
  "local_ip" : "aeiou",
  "metadata" : [ {
    "val" : "aeiou",
    "key" : "aeiou"
  } ],
  "marked_for_delete" : true,
  "is_controller" : true,
  "ip" : "aeiou",
  "name" : "aeiou",
  "pub_key_pem" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "pub_key" : "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 /securechannel/{uuid}
(securechannelUuidPatch)

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
{
  "local_ip" : "aeiou",
  "metadata" : [ {
    "val" : "aeiou",
    "key" : "aeiou"
  } ],
  "marked_for_delete" : true,
  "is_controller" : true,
  "ip" : "aeiou",
  "name" : "aeiou",
  "pub_key_pem" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "pub_key" : "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 /securechannel/{uuid}
(securechannelUuidPut)

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
{
  "local_ip" : "aeiou",
  "metadata" : [ {
    "val" : "aeiou",
    "key" : "aeiou"
  } ],
  "marked_for_delete" : true,
  "is_controller" : true,
  "ip" : "aeiou",
  "name" : "aeiou",
  "pub_key_pem" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "pub_key" : "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).
ip (optional)
String ip of SecureChannelMapping.
is_controller (optional)
Boolean Placeholder for description of property is_controller of obj type SecureChannelMapping field type str type boolean
local_ip (optional)
String local_ip of SecureChannelMapping.
marked_for_delete (optional)
Boolean Placeholder for description of property marked_for_delete of obj type SecureChannelMapping field type str type boolean
metadata (optional)
array[SecureChannelMetadata] Metadata associated with the SecureChannelToken of the service engine. Field introduced in 20.1.3.
name
String Name of the object.
pub_key (optional)
String pub_key of SecureChannelMapping.
pub_key_pem (optional)
String pub_key_pem of SecureChannelMapping.
status (optional)
String 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.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

SecureChannelMappingApiResponse Up

count
Integer format: int32
results
array[SecureChannelMapping]
next (optional)
String

SecureChannelMetadata Up

key (optional)
String key of SecureChannelMetadata.
val (optional)
String val of SecureChannelMetadata.