List Registrations By State.

POST

/api/register/namespaces/{namespace}/listregistrationsbystate

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/register/namespaces/example/listregistrationsbystate \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "namespace": "example", "state": "NOTSET" }'

• F5 Distributed Cloud Console

API endpoint for returning Registrations by status, e.g APPROVED, NEW, or RETIRED.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace

x-required Registration namespace, only “system” namespaces is accepted.

Request Body^required

Media typeapplication/json

ListStateReq

Request for list registrations.

object

namespace

Namespace

Registration namespace, only “system” namespaces is accepted Required: YES.

string

>= 6 characters <= 1024 characters

state

string

default: NOTSET

Allowed values: NOTSET NEW APPROVED ADMITTED RETIRED FAILED DONE PENDING ONLINE UPGRADING MAINTENANCE FAILED_INACTIVE

Responses

200

A successful response.

Media typeapplication/json

ListResponse is the collection of registration

This is the output message of ‘List’ RPC.

object

errors

errors

Errors(if any) while listing items from collection.

Array<object>

ErrorType

Information about a error in API operation.

object

code

string

default: EOK

Allowed values: EOK EPERMS EBADINPUT ENOTFOUND EEXISTS EUNKNOWN ESERIALIZE EINTERNAL EPARTIAL

error_obj

object

type_url

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one ”/” character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.duration). The name should be in a canonical form (e.g., leading ”.” is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme HTTP, HTTPS, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

• If no scheme is provided, HTTPS is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than HTTP, HTTPS (or the empty scheme) might be used with implementation specific semantics.

string

<= 1024 characters

value

Must be a valid serialized protocol buffer of the above specified type.

string format: byte

>= 3 characters <= 1024 characters

message

message

A human readable string of the error.

string

<= 1024 characters

items

items

Items represents the collection in response.

Array<object>

ListResponseItem is an individual item in a collection of registration

By default a summary of registration is returned in ‘List’. By setting ‘report_fields’ in the ListRequest more details of each item can be got.

object

annotations

annotations

The set of annotations present on this registration.

object

description

description

The description set for this registration.

string

>= 21 characters <= 1024 characters

disabled

disabled

A value of true indicates registration is administratively disabled.

boolean format: boolean

get_spec

object

infra

object

availability_zone

availability_zone

An Availability Zone is a high-availability offering that protects your applications and data from datacenter failures.

string

<= 1024 characters

certified_hw

Certified hardware name

Certified HW name used to map with F5XC certified_hardware definition.

string

<= 1024 characters

domain

Instance domain

Machine domain. It’s used for Kubernetes cloud provider when domain must be different than F5 Distributed Cloud.

string format: hostname

>= 26 characters <= 1024 characters

hostname

Instance hostname

Must be unique in entire cluster and same as OS settings. ’.’ (dots) are not allowed in hostname Required: YES.

string

<= 1024 characters

hw_info

object

bios

object

date

date

Information from /sys/class/dmi/ID/bios_date.

string

<= 1024 characters

vendor

vendor

Information from /sys/class/dmi/ID/bios_vendor.

string

<= 1024 characters

version

version

Information from /sys/class/dmi/ID/bios_version.

string

>= 1 characters <= 1024 characters

board

object

asset_tag

asset_tag

Information from /sys/class/dmi/ID/board_asset_tag.

string

<= 1024 characters

name

name

Information from /sys/class/dmi/ID/board_name.

string

>= 6 characters <= 1024 characters

serial

serial

Information from /sys/class/dmi/ID/board_serial.

string

<= 1024 characters

vendor

vendor

Information from /sys/class/dmi/ID/board_vendor.

string

<= 1024 characters

version

version

Information from /sys/class/dmi/ID/board_version.

string

>= 1 characters <= 1024 characters

chassis

object

asset_tag

asset_tag

Information from /sys/class/dmi/ID/chassis_asset_tag.

string

<= 1024 characters

serial

serial

Information from /sys/class/dmi/ID/chassis_serial.

string

<= 1024 characters

type

type

Information from /sys/class/dmi/ID/chassis_type.

integer format: int64

vendor

vendor

Information from /sys/class/dmi/ID/chassis_vendor.

string

<= 1024 characters

version

version

Information from /sys/class/dmi/ID/chassis_version.

string

>= 1 characters <= 1024 characters

cpu

object

cache

cache

CPU cache size in KB.

integer format: int64

cores

cores

Number of physical CPU cores.

integer format: int64

cpus

cpus

Number of physical CPUs.

integer format: int64

model

model

CPU model

string

<= 1024 characters

speed

speed

CPU clock rate in MHz.

integer format: int64

threads

threads

Number of logical (HT) CPU cores.

integer format: int64

vendor

vendor

CPU vendor.

string

<= 1024 characters

gpu

object

cuda_version

cudaVersion

GPU Cuda Version.

string

<= 1024 characters

driver_version

driverVersion

GPU Driver Version.

string

<= 1024 characters

gpu_device

GPUDevice

List of GPU devices in server.

Array<object>

GPUDevice

object

id

id

GPU ID

string

>= 1 <= 4094 <= 1024 characters

processes

processes

GPU Processes.

string

<= 1024 characters

product_name

productName

GPU Product Name.

string

<= 1024 characters

kernel

object

architecture

architecture

Kernel architecture.

string

<= 1024 characters

release

release

Kernel release.

string

<= 1024 characters

version

version

Kernel version.

string

>= 1 characters <= 1024 characters

memory

object

size_mb

size_mb

RAM size in MB.

integer format: int64

speed

speed

RAM data rate in MT/s.

integer format: int64

type

type

Type of memory, eg. DDR4.

string

<= 1024 characters

network

network

List of network devices in server.

Array<object>

Network Device Information

NetworkDevice information.

object

driver

driver

Driver of device, eg. E1000e.

string

<= 1024 characters

ip_address

ip_address

IP address on interface.

Array<string>

link_quality

string

default: QUALITY_UNKNOWN

Allowed values: QUALITY_UNKNOWN QUALITY_GOOD QUALITY_POOR QUALITY_DISABLED

link_type

string

default: LINK_TYPE_UNKNOWN

Allowed values: LINK_TYPE_UNKNOWN LINK_TYPE_ETHERNET LINK_TYPE_WIFI_802_11AC LINK_TYPE_WIFI_802_11BGN LINK_TYPE_4G LINK_TYPE_WIFI LINK_TYPE_WAN

mac_address

mac_address

MAC address on interface.

string

<= 1024 characters

name

name

Name of device, eg. Eth0.

string

>= 6 characters <= 1024 characters

port

port

Used port, eg. Tp.

string

>= 1 <= 65535 <= 1024 characters

speed

speed

Device max supported speed in Mbps.

integer format: int64

numa_nodes

NUMA Nodes Count

Non-uniform memory access (NUMA) nodes count.

integer format: int32

os

object

architecture

architecture

Architecture of OS.

string

<= 1024 characters

name

name

Name of OS.

string

>= 6 characters <= 1024 characters

release

release

Release of the OS.

string

<= 1024 characters

vendor

vendor

Vendor of OS.

string

<= 1024 characters

version

version

Version of OS.

string

>= 1 characters <= 1024 characters

product

object

name

name

Product name, eg. For AWS m5a.xlarge. Info taken from /sys/class/dmi/ID/product_name.

string

>= 6 characters <= 1024 characters

serial

serial

Serial number, eg. For AWS ec254b6d-9676-1a51-8b10-21370dbdc3e5. Info taken from /sys/class/dmi/ID/product_serial.

string

<= 1024 characters

vendor

vendor

Vendor name, eg. For AWS Amazon EC2. Info taken from /sys/class/dmi/ID/product_vendor.

string

<= 1024 characters

version

version

Version name. Info taken from /sys/class/dmi/ID/product_version.

string

>= 1 characters <= 1024 characters

storage

storage

List of storage devices in server.

Array<object>

Storage Information

StorageDevice information.

object

driver

driver

Driver of device.

string

<= 1024 characters

model

model

Model of device.

string

<= 1024 characters

name

name

Name of device, eg. Nvme0n1.

string

>= 6 characters <= 1024 characters

serial

serial

Serial of device.

string

<= 1024 characters

size_gb

size_gb

Device size in GB.

integer format: int64

vendor

vendor

Vendor of device.

string

<= 1024 characters

usb

USBDevice

List of USB devices in server.

Array<object>

USB device

Information about USB device.

object

address

address

Address of the device on the bus in decimal.

integer format: int64

b_device_class

b_device_class

The class of this device.

string

<= 1024 characters

b_device_protocol

b_device_protocol

The protocol (within the sub-class) of this device.

string

<= 1024 characters

b_device_sub_class

b_device_sub_class

The sub-class (within the class) of this device.

string

<= 1024 characters

b_max_packet_size

b_max_packet_size

Maximum size of the control transfer.

integer format: int64

bcd_device

bcd_device

The device version.

string

<= 1024 characters

bcd_usb

bcd_usb

USB Specification Release Number.

string

<= 1024 characters

bus

bus

The bus on which the device was detected in decimal.

integer format: int64

description

description

Device description.

string

>= 21 characters <= 1024 characters

i_manufacturer

i_manufacturer

Manufacturer name.

string

<= 1024 characters

i_product

i_product

Product name reported by device.

string

<= 1024 characters

i_serial

i_serial_number

Index of Serial Number String Descriptor.

string

<= 1024 characters

id_product

id_product

Product ID (Assigned by Manufacturer) in hex.

string

<= 1024 characters

id_vendor

id_vendor

Vendor ID (Assigned by USB Org) in hex.

string

<= 1024 characters

port

port

Port on which the device was detected in decimal.

integer format: int64

>= 1 <= 65535

product_name

product_name

Product ID translated to name (if available)

string

<= 1024 characters

speed

speed

The negotiated operating speed for the device.

string

<= 1024 characters

usb_type

string

default: UNKNOWN_USB

Allowed values: UNKNOWN_USB INTERNAL REGISTERED CONFIGURABLE

vendor_name

vendor_name

Vendor ID translated to name (if available)

string

<= 1024 characters

instance_id

Instance ID

Instance ID (assigned by infrastructure provider)

string

<= 1024 characters

interfaces

Interfaces

Machine interfaces present during registration time

Required: YES.

object

internet_proxy

object

http_proxy

Http Proxy

It will be used as the proxy URL for HTTP requests and HTTPS requests unless overridden by HTTPSProxy or NoProxy.

string

<= 1024 characters

https_proxy

Https Proxy

It will be used as the proxy URL for HTTPS requests unless overridden by NoProxy.

string

<= 1024 characters

no_proxy

No Proxy

It specifies a string that contains comma-separated values specifying hosts that should be excluded from proxying. Each value is represented by an IP address prefix (1.2.3.4), an IP address prefix in CIDR notation (1.2.3.4/8), a domain name, or a special DNS label (). An IP address prefix and domain name can also include a literal port number (1.2.3.4:80). A domain name matches that name and all subdomains. A domain name with a leading ”.” matches subdomains only. For example “example.com” matches “example.com” and “bar.example.com”; “.y.com” matches “x.y.com” but not “y.com”. A single asterisk () indicates that no proxying should be done.

string

<= 1024 characters

proxy_cacert_url

Proxy CA certificate URL

Allow optional different trust-store for proxy in HTTP CONNECT step by picking proxy CA certificate value.

string

<= 1024 characters

is_slo_static

Is SLO Static

Indicates whether the SLO is static.

boolean format: boolean

machine_id

Machine ID

Machine ID - generated by operating system.

string

<= 1024 characters

provider

string

default: UNKNOWN

Allowed values: UNKNOWN AWS GOOGLE AZURE VMWARE KVM OTHER VOLTERRA IBMCLOUD UNKNOWN_K8S AWS_K8S GCP_K8S AZURE_K8S VMWARE_K8S KVM_K8S OTHER_K8S VOLTERRA_K8S IBMCLOUD_K8S F5OS RSERIES OCI NUTANIX OPENSTACK EQUINIX OPENSHIFT_VIRTUALIZATION

sw_info

object

sw_version

sw version

SW Version in the site.

string

<= 1024 characters

timestamp

Timestamp

It’s used to verify machine have acceptable time difference from server.

string format: date-time

<= 1024 characters

zone

Zone

Instance zone (or region), depends on provider.

string

<= 1024 characters

passport

object

cluster_name

cluster_name

Required: YES.

string

<= 1024 characters

cluster_size

Cluster size

Defines how many master nodes is in the cluster, only 1 or 3 is allowed 1 - cluster have single master, without HA 3 - cluster have 3 masters, with HA, all nodes should be allowed at same time, cluster won’t start until ALL nodes are ADMITTED 0 - same as 1 This value can’t be changed after installation. It does not interact with auto-scaling as only pool nodes are scaled.

integer format: int32

cluster_type

cluster_type

Required: YES.

string

<= 1024 characters

default_os_version

object

default_sw_version

object

latitude

Latitude

Geographic location of this site Required: YES.

number format: float

longitude

Longitude

Geographic location of this site Required: YES.

number format: float

operating_system_version

Operating System Version

Exclusive with [default_os_version] Operating System Version is optional parameter, which allows to specify target SW version for particular site e.g. 7.2009.10.

string

<= 20 characters

private_network_name

Private Network Name

Private Network name for private access connectivity to F5XC ADN. It is used for PrivateLink, CloudLink and L3VPN.

string

<= 64 characters

volterra_software_version

F5XC Software Version

Exclusive with [default_sw_version] F5XC Software Version is optional parameter, which allows to specify target SW version for particular site e.g. Crt-20210329-1002.

string

<= 20 characters

token

Token is used for machine and tenant identification Required: YES.

string

<= 1024 characters

labels

labels

The set of labels present on this registration.

object

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

name

name

The name of this registration.

string

>= 6 characters <= 1024 characters

namespace

namespace

The namespace this item belongs to.

string

>= 6 characters <= 1024 characters

object

object

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

uid

uid

Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system. Typically generated by the server on successful creation of an object and is not allowed to change once populated. Shadowed by SystemObjectMeta’s uid field.

string format: uuid

>= 36 characters <= 1024 characters

spec

object

gc_spec

object

connected_regions

Connected Region

Optional. REs in selected region to which CEs connect, contains primary and backup RE region info.

Array<string>

infra

object

availability_zone

availability_zone

An Availability Zone is a high-availability offering that protects your applications and data from datacenter failures.

string

<= 1024 characters

certified_hw

Certified hardware name

Certified HW name used to map with F5XC certified_hardware definition.

string

<= 1024 characters

domain

Instance domain

Machine domain. It’s used for Kubernetes cloud provider when domain must be different than F5 Distributed Cloud.

string format: hostname

>= 26 characters <= 1024 characters

hostname

Instance hostname

Must be unique in entire cluster and same as OS settings. ’.’ (dots) are not allowed in hostname Required: YES.

string

<= 1024 characters

hw_info

object

bios

object

date

date

Information from /sys/class/dmi/ID/bios_date.

string

<= 1024 characters

vendor

vendor

Information from /sys/class/dmi/ID/bios_vendor.

string

<= 1024 characters

version

version

Information from /sys/class/dmi/ID/bios_version.

string

>= 1 characters <= 1024 characters

board

object

asset_tag

asset_tag

Information from /sys/class/dmi/ID/board_asset_tag.

string

<= 1024 characters

name

name

Information from /sys/class/dmi/ID/board_name.

string

>= 6 characters <= 1024 characters

serial

serial

Information from /sys/class/dmi/ID/board_serial.

string

<= 1024 characters

vendor

vendor

Information from /sys/class/dmi/ID/board_vendor.

string

<= 1024 characters

version

version

Information from /sys/class/dmi/ID/board_version.

string

>= 1 characters <= 1024 characters

chassis

object

asset_tag

asset_tag

Information from /sys/class/dmi/ID/chassis_asset_tag.

string

<= 1024 characters

serial

serial

Information from /sys/class/dmi/ID/chassis_serial.

string

<= 1024 characters

type

type

Information from /sys/class/dmi/ID/chassis_type.

integer format: int64

vendor

vendor

Information from /sys/class/dmi/ID/chassis_vendor.

string

<= 1024 characters

version

version

Information from /sys/class/dmi/ID/chassis_version.

string

>= 1 characters <= 1024 characters

cpu

object

cache

cache

CPU cache size in KB.

integer format: int64

cores

cores

Number of physical CPU cores.

integer format: int64

cpus

cpus

Number of physical CPUs.

integer format: int64

model

model

CPU model

string

<= 1024 characters

speed

speed

CPU clock rate in MHz.

integer format: int64

threads

threads

Number of logical (HT) CPU cores.

integer format: int64

vendor

vendor

CPU vendor.

string

<= 1024 characters

gpu

object

cuda_version

cudaVersion

GPU Cuda Version.

string

<= 1024 characters

driver_version

driverVersion

GPU Driver Version.

string

<= 1024 characters

gpu_device

GPUDevice

List of GPU devices in server.

Array<object>

GPUDevice

object

id

id

GPU ID

string

>= 1 <= 4094 <= 1024 characters

processes

processes

GPU Processes.

string

<= 1024 characters

product_name

productName

GPU Product Name.

string

<= 1024 characters

kernel

object

architecture

architecture

Kernel architecture.

string

<= 1024 characters

release

release

Kernel release.

string

<= 1024 characters

version

version

Kernel version.

string

>= 1 characters <= 1024 characters

memory

object

size_mb

size_mb

RAM size in MB.

integer format: int64

speed

speed

RAM data rate in MT/s.

integer format: int64

type

type

Type of memory, eg. DDR4.

string

<= 1024 characters

network

network

List of network devices in server.

Array<object>

Network Device Information

NetworkDevice information.

object

driver

driver

Driver of device, eg. E1000e.

string

<= 1024 characters

ip_address

ip_address

IP address on interface.

Array<string>

link_quality

string

default: QUALITY_UNKNOWN

Allowed values: QUALITY_UNKNOWN QUALITY_GOOD QUALITY_POOR QUALITY_DISABLED

link_type

string

default: LINK_TYPE_UNKNOWN

Allowed values: LINK_TYPE_UNKNOWN LINK_TYPE_ETHERNET LINK_TYPE_WIFI_802_11AC LINK_TYPE_WIFI_802_11BGN LINK_TYPE_4G LINK_TYPE_WIFI LINK_TYPE_WAN

mac_address

mac_address

MAC address on interface.

string

<= 1024 characters

name

name

Name of device, eg. Eth0.

string

>= 6 characters <= 1024 characters

port

port

Used port, eg. Tp.

string

>= 1 <= 65535 <= 1024 characters

speed

speed

Device max supported speed in Mbps.

integer format: int64

numa_nodes

NUMA Nodes Count

Non-uniform memory access (NUMA) nodes count.

integer format: int32

os

object

architecture

architecture

Architecture of OS.

string

<= 1024 characters

name

name

Name of OS.

string

>= 6 characters <= 1024 characters

release

release

Release of the OS.

string

<= 1024 characters

vendor

vendor

Vendor of OS.

string

<= 1024 characters

version

version

Version of OS.

string

>= 1 characters <= 1024 characters

product

object

name

name

Product name, eg. For AWS m5a.xlarge. Info taken from /sys/class/dmi/ID/product_name.

string

>= 6 characters <= 1024 characters

serial

serial

Serial number, eg. For AWS ec254b6d-9676-1a51-8b10-21370dbdc3e5. Info taken from /sys/class/dmi/ID/product_serial.

string

<= 1024 characters

vendor

vendor

Vendor name, eg. For AWS Amazon EC2. Info taken from /sys/class/dmi/ID/product_vendor.

string

<= 1024 characters

version

version

Version name. Info taken from /sys/class/dmi/ID/product_version.

string

>= 1 characters <= 1024 characters

storage

storage

List of storage devices in server.

Array<object>

Storage Information

StorageDevice information.

object

driver

driver

Driver of device.

string

<= 1024 characters

model

model

Model of device.

string

<= 1024 characters

name

name

Name of device, eg. Nvme0n1.

string

>= 6 characters <= 1024 characters

serial

serial

Serial of device.

string

<= 1024 characters

size_gb

size_gb

Device size in GB.

integer format: int64

vendor

vendor

Vendor of device.

string

<= 1024 characters

usb

USBDevice

List of USB devices in server.

Array<object>

USB device

Information about USB device.

object

address

address

Address of the device on the bus in decimal.

integer format: int64

b_device_class

b_device_class

The class of this device.

string

<= 1024 characters

b_device_protocol

b_device_protocol

The protocol (within the sub-class) of this device.

string

<= 1024 characters

b_device_sub_class

b_device_sub_class

The sub-class (within the class) of this device.

string

<= 1024 characters

b_max_packet_size

b_max_packet_size

Maximum size of the control transfer.

integer format: int64

bcd_device

bcd_device

The device version.

string

<= 1024 characters

bcd_usb

bcd_usb

USB Specification Release Number.

string

<= 1024 characters

bus

bus

The bus on which the device was detected in decimal.

integer format: int64

description

description

Device description.

string

>= 21 characters <= 1024 characters

i_manufacturer

i_manufacturer

Manufacturer name.

string

<= 1024 characters

i_product

i_product

Product name reported by device.

string

<= 1024 characters

i_serial

i_serial_number

Index of Serial Number String Descriptor.

string

<= 1024 characters

id_product

id_product

Product ID (Assigned by Manufacturer) in hex.

string

<= 1024 characters

id_vendor

id_vendor

Vendor ID (Assigned by USB Org) in hex.

string

<= 1024 characters

port

port

Port on which the device was detected in decimal.

integer format: int64

>= 1 <= 65535

product_name

product_name

Product ID translated to name (if available)

string

<= 1024 characters

speed

speed

The negotiated operating speed for the device.

string

<= 1024 characters

usb_type

string

default: UNKNOWN_USB

Allowed values: UNKNOWN_USB INTERNAL REGISTERED CONFIGURABLE

vendor_name

vendor_name

Vendor ID translated to name (if available)

string

<= 1024 characters

instance_id

Instance ID

Instance ID (assigned by infrastructure provider)

string

<= 1024 characters

interfaces

Interfaces

Machine interfaces present during registration time

Required: YES.

object

internet_proxy

object

http_proxy

Http Proxy

It will be used as the proxy URL for HTTP requests and HTTPS requests unless overridden by HTTPSProxy or NoProxy.

string

<= 1024 characters

https_proxy

Https Proxy

It will be used as the proxy URL for HTTPS requests unless overridden by NoProxy.

string

<= 1024 characters

no_proxy

No Proxy

It specifies a string that contains comma-separated values specifying hosts that should be excluded from proxying. Each value is represented by an IP address prefix (1.2.3.4), an IP address prefix in CIDR notation (1.2.3.4/8), a domain name, or a special DNS label (). An IP address prefix and domain name can also include a literal port number (1.2.3.4:80). A domain name matches that name and all subdomains. A domain name with a leading ”.” matches subdomains only. For example “example.com” matches “example.com” and “bar.example.com”; “.y.com” matches “x.y.com” but not “y.com”. A single asterisk () indicates that no proxying should be done.

string

<= 1024 characters

proxy_cacert_url

Proxy CA certificate URL

Allow optional different trust-store for proxy in HTTP CONNECT step by picking proxy CA certificate value.

string

<= 1024 characters

is_slo_static

Is SLO Static

Indicates whether the SLO is static.

boolean format: boolean

machine_id

Machine ID

Machine ID - generated by operating system.

string

<= 1024 characters

provider

string

default: UNKNOWN

Allowed values: UNKNOWN AWS GOOGLE AZURE VMWARE KVM OTHER VOLTERRA IBMCLOUD UNKNOWN_K8S AWS_K8S GCP_K8S AZURE_K8S VMWARE_K8S KVM_K8S OTHER_K8S VOLTERRA_K8S IBMCLOUD_K8S F5OS RSERIES OCI NUTANIX OPENSTACK EQUINIX OPENSHIFT_VIRTUALIZATION

sw_info

object

sw_version

sw version

SW Version in the site.

string

<= 1024 characters

timestamp

Timestamp

It’s used to verify machine have acceptable time difference from server.

string format: date-time

<= 1024 characters

zone

Zone

Instance zone (or region), depends on provider.

string

<= 1024 characters

passport

object

cluster_name

cluster_name

Required: YES.

string

<= 1024 characters

cluster_size

Cluster size

Defines how many master nodes is in the cluster, only 1 or 3 is allowed 1 - cluster have single master, without HA 3 - cluster have 3 masters, with HA, all nodes should be allowed at same time, cluster won’t start until ALL nodes are ADMITTED 0 - same as 1 This value can’t be changed after installation. It does not interact with auto-scaling as only pool nodes are scaled.

integer format: int32

cluster_type

cluster_type

Required: YES.

string

<= 1024 characters

default_os_version

object

default_sw_version

object

latitude

Latitude

Geographic location of this site Required: YES.

number format: float

longitude

Longitude

Geographic location of this site Required: YES.

number format: float

operating_system_version

Operating System Version

Exclusive with [default_os_version] Operating System Version is optional parameter, which allows to specify target SW version for particular site e.g. 7.2009.10.

string

<= 20 characters

private_network_name

Private Network Name

Private Network name for private access connectivity to F5XC ADN. It is used for PrivateLink, CloudLink and L3VPN.

string

<= 64 characters

volterra_software_version

F5XC Software Version

Exclusive with [default_sw_version] F5XC Software Version is optional parameter, which allows to specify target SW version for particular site e.g. Crt-20210329-1002.

string

<= 20 characters

role

Instance role

Role of registered node. Used by system to determine what roles should be enforced.

Array<string>

site

Site

Site for this registration, assigned after registration is assigned to site.

Array<object>

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

token

Token

Token is used for machine and tenant identification Required: YES.

string

<= 1024 characters

tunnel_type

string

default: SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL

Allowed values: SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL SITE_TO_SITE_TUNNEL_IPSEC SITE_TO_SITE_TUNNEL_SSL

status

object

current_state

string

default: NOTSET

Allowed values: NOTSET NEW APPROVED ADMITTED RETIRED FAILED DONE PENDING ONLINE UPGRADING MAINTENANCE FAILED_INACTIVE

object_status

object

code

code

Suggested HTTP return code for this status, 0 if not set.

integer format: int32

reason

reason

A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.

string

>= 27 characters <= 1024 characters

status

status

Status of the operation. One of: “Success” or “Failure”.

string

>= 17 characters <= 1024 characters

parent_current_state

string

default: ONLINE

Allowed values: ONLINE PROVISIONING UPGRADING STANDBY FAILED REREGISTRATION WAITINGNODES DECOMMISSIONING WAITING_FOR_REGISTRATION ORCHESTRATION_IN_PROGRESS ORCHESTRATION_COMPLETE ERROR_IN_ORCHESTRATION DELETING_CLOUD_RESOURCES DELETED_CLOUD_RESOURCES ERROR_DELETING_CLOUD_RESOURCES VALIDATION_IN_PROGRESS VALIDATION_SUCCESS VALIDATION_FAILED FAILED_INACTIVE UPDATING_CLOUD_RESOURCES ERROR_UPDATING_CLOUD_RESOURCES ORCHESTRATION_QUEUED UPDATE_QUEUED DELETE_QUEUED

state_update_timestamp

Modification timestamp for state of registration

Time of last registration state update.

string format: date-time

<= 1024 characters

system_metadata

object

creation_timestamp

creation_timestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

string format: date-time

<= 1024 characters

creator_class

creator_class

A value identifying the class of the user or service which created this configuration object.

string

<= 1024 characters

creator_cookie

creator_cookie

This can used by the creator of the object for later audit for e.g. By storing the version identifying information of the object so at future it can be determined if version present at remote end is current or stale.

string

<= 1024 characters

creator_id

creator_id

A value identifying the exact user or service that created this configuration object.

string

<= 1024 characters

deletion_timestamp

deletion_timestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only.

string format: date-time

<= 1024 characters

direct_ref_hash

direct_ref_hash

A hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.

string

<= 1024 characters

finalizers

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

Array<string>

initializers

object

pending

pending

Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

Array<object>

InitializerType

Initializer is information about an initializer that has not yet completed.

object

name

name

Name of the service that is responsible for initializing this object.

string

>= 6 characters <= 1024 characters

result

object

code

code

Suggested HTTP return code for this status, 0 if not set.

integer format: int32

reason

reason

A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.

string

>= 27 characters <= 1024 characters

status

status

Status of the operation. One of: “Success” or “Failure”.

string

>= 17 characters <= 1024 characters

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).

object

modification_timestamp

modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this object was last modified.

string format: date-time

<= 1024 characters

namespace

namespace

The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.

Array<object>

>= 6 characters <= 6 characters <= 1 items

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

object_index

object_index

Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.

integer format: int64

owner_view

object

kind

kind

Kind of the view object.

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

uid

uid

UID of the view object.

string format: uuid

>= 36 characters <= 1024 characters

revision

revision

A revision number which always increases with each modification of the object in storage This doesn’t necessarily increase sequentially, but should always increase. This will be 0 when first created, and before any modifications.

string format: int64

<= 1024 characters

sre_disable

sre_disable

This should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g. Due to bad-form/issue-causing Object). This is meant only to be used in temporary situations for operational continuity till a fix is rolled out in business-logic.

boolean format: boolean

tenant

tenant

Tenant to which this configuration object belongs to. The value for this is found from presented credentials.

string

>= 6 characters <= 1024 characters

trace_info

trace_info

Trace_info holds information(::) of the request doing the object modification. This can be used on the watch side to create subsequent spans. This information can be used to co-relate activities across services (modulo state compression) for a synchronous API.

string

<= 1024 characters

uid

uid

Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.

string format: uuid

>= 36 characters <= 1024 characters

vtrp_id

vtrp_id

Indicate origin of this object.

string

<= 1024 characters

vtrp_stale

vtrp_stale

Indicate whether mars deems this object to be stale via graceful restart timer information.

boolean format: boolean

owner_view

object

kind

kind

Kind of the view object.

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

uid

uid

UID of the view object.

string format: uuid

>= 36 characters <= 1024 characters

system_metadata

object

creation_timestamp

creation_timestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

string format: date-time

<= 1024 characters

creator_class

creator_class

A value identifying the class of the user or service which created this configuration object.

string

<= 1024 characters

creator_id

creator_id

A value identifying the exact user or service that created this configuration object.

string

<= 1024 characters

deletion_timestamp

deletion_timestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only.

string format: date-time

<= 1024 characters

finalizers

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

Array<string>

initializers

object

pending

pending

Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

Array<object>

InitializerType

Initializer is information about an initializer that has not yet completed.

object

name

name

Name of the service that is responsible for initializing this object.

string

>= 6 characters <= 1024 characters

result

object

code

code

Suggested HTTP return code for this status, 0 if not set.

integer format: int32

reason

reason

A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.

string

>= 27 characters <= 1024 characters

status

status

Status of the operation. One of: “Success” or “Failure”.

string

>= 17 characters <= 1024 characters

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).

object

modification_timestamp

modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this object was last modified.

string format: date-time

<= 1024 characters

object_index

object_index

Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.

integer format: int64

owner_view

object

kind

kind

Kind of the view object.

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

uid

uid

UID of the view object.

string format: uuid

>= 36 characters <= 1024 characters

tenant

tenant

Tenant to which this configuration object belongs to. The value for this is found from presented credentials.

string

>= 6 characters <= 1024 characters

uid

uid

Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.

string format: uuid

>= 36 characters <= 1024 characters

tenant

tenant

The tenant this item belongs to.

string

>= 6 characters <= 1024 characters

uid

uid

The unique uid of this registration.

string format: uuid

>= 36 characters <= 1024 characters

Example

{
  "errors": [
    {
      "code": "EOK"
    }
  ],
  "items": [
    {
      "get_spec": {
        "infra": {
          "hw_info": {
            "network": [
              {
                "link_quality": "QUALITY_UNKNOWN",
                "link_type": "LINK_TYPE_UNKNOWN"
              }
            ],
            "usb": [
              {
                "usb_type": "UNKNOWN_USB"
              }
            ]
          },
          "provider": "UNKNOWN"
        }
      },
      "object": {
        "spec": {
          "gc_spec": {
            "infra": {
              "hw_info": {
                "network": [
                  {
                    "link_quality": "QUALITY_UNKNOWN",
                    "link_type": "LINK_TYPE_UNKNOWN"
                  }
                ],
                "usb": [
                  {
                    "usb_type": "UNKNOWN_USB"
                  }
                ]
              },
              "provider": "UNKNOWN"
            },
            "tunnel_type": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL"
          }
        },
        "status": {
          "current_state": "NOTSET",
          "parent_current_state": "ONLINE"
        }
      }
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example