GET App Stack site.

GET

/api/config/namespaces/{namespace}/voltstack_sites/{name}

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/voltstack_sites/example?response_format=GET_RSP_FORMAT_DEFAULT';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/voltstack_sites/example?response_format=GET_RSP_FORMAT_DEFAULT' \
  --header 'Authorization: <Authorization>'

Shape of the App Stack site specification.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace The namespace in which the configuration object is present.

name

required

string

Name The name of the configuration object to be fetched.

Query Parameters

response_format

string

default: GET_RSP_FORMAT_DEFAULT

Allowed values: GET_RSP_FORMAT_DEFAULT GET_RSP_FORMAT_FOR_CREATE GET_RSP_FORMAT_FOR_REPLACE GET_RSP_FORMAT_STATUS GET_RSP_FORMAT_READ GET_RSP_FORMAT_REFERRING_OBJECTS GET_RSP_FORMAT_BROKEN_REFERENCES

The format in which the configuration object is to be fetched. This could be for example

in GetSpec form for the contents of object
in CreateRequest form to create a new similar object
to ReplaceRequest form to replace changeable values

Default format of returned resource Response should be in CreateRequest format Response should be in ReplaceRequest format Response should be in StatusObject(s) format Response should be in format of GetSpecType Response should have other objects referring to this object Response should have deleted and disabled objects referrred by this object.

Responses

200

A successful response.

application/json

GetResponse is the shape of a read voltstack_site

This is the output message of the ‘GET’ RPC.

object

create_form

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

spec

object

address

Site’s geographical address that can be used to determine its latitude and longitude.

string

<= 256 characters

allow_all_usb

object

blocked_services

object

blocked_sevice

Disable Node Local Services

Blocking or denial configuration

Array<object>

Disable Node Local Service

Disable a node local service on this site.

object

dns

object

network_type

string

default: VIRTUAL_NETWORK_SITE_LOCAL

Allowed values: VIRTUAL_NETWORK_SITE_LOCAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE VIRTUAL_NETWORK_PER_SITE VIRTUAL_NETWORK_PUBLIC VIRTUAL_NETWORK_GLOBAL VIRTUAL_NETWORK_SITE_SERVICE VIRTUAL_NETWORK_VER_INTERNAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE VIRTUAL_NETWORK_IP_AUTO VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK VIRTUAL_NETWORK_SRV6_NETWORK VIRTUAL_NETWORK_IP_FABRIC VIRTUAL_NETWORK_SEGMENT VIRTUAL_NETWORK_MANAGEMENT

ssh

object

web_user_interface

object

bond_device_list

object

bond_devices

Bond Devices List

List of bond devices

Required: YES.

Array<object>

>= 1 items <= 4 items

Bond Device

Bond devices configuration for fleet.

object

active_backup

object

devices

Member Ethernet Devices

Ethernet devices that will make up this bond Required: YES.

Array<string>

>= 1 items <= 8 items

lacp

object

rate

Interval

Interval in seconds to transmit LACP packets.

integer format: int64

link_polling_interval

Link Polling Interval

Link polling interval in milliseconds Required: YES.

integer format: int64

link_up_delay

Link Up Delay

Milliseconds wait before link is declared up Required: YES.

integer format: int64

name

Bond Device

Name for the Bond. Ex ‘bond0’ Required: YES.

string

>= 6 characters <= 64 characters

coordinates

object

latitude

latitude

Latitude of the site location.

number format: float

longitude

longitude

Longitude of site location.

number format: float

custom_dns

object

inside_nameserver

inside_nameserver

Optional DNS server IP to be used for name resolution in inside network.

string

<= 1024 characters

outside_nameserver

outside_nameserver

Optional DNS server IP to be used for name resolution in outside network.

string

<= 1024 characters

custom_network_config

object

active_enhanced_firewall_policies

object

enhanced_firewall_policies

Enhanced Firewall Policy

Ordered List of Enhanced Firewall Policies active

Required: YES.

Array<object>

>= 1 items <= 128 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

active_forward_proxy_policies

object

forward_proxy_policies

Forward Proxy Policies

Ordered List of Forward Proxy Policies active

Required: YES.

Array<object>

>= 1 items <= 128 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

active_network_policies

object

network_policies

Firewall Policy

Ordered List of Firewall Policies active for this network firewall

Required: YES.

Array<object>

>= 1 items <= 128 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

bgp_peer_address

bgp_peer_address

Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.

string

<= 1024 characters

bgp_router_id

bgp_router_id

Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object.

string

<= 1024 characters

default_config

object

default_interface_config

object

default_sli_config

object

forward_proxy_allow_all

object

global_network_list

object

global_network_connections

Global Network Connections

Global network connections

Required: YES.

Array<object>

>= 1 items <= 8 items

Global Network Connection

Global network connection.

object

sli_to_global_dr

object

global_vn

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

slo_to_global_dr

object

global_vn

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

interface_list

object

interfaces

List of Interfaces

Configure network interfaces for this App Stack site

Required: YES.

Array<object>

>= 1 items <= 128 items

Interface

Interface definition.

object

dc_cluster_group_connectivity_interface_disabled

object

dc_cluster_group_connectivity_interface_enabled

object

dedicated_interface

object

cluster

object

device

Device

Name of the device for which interface is configured. Use wwan0 for 4G/LTE. Required: YES.

string

>= 1 characters <= 64 characters

is_primary

object

monitor

object

monitor_disabled

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node of the site.

string

>= 1 characters <= 64 characters

not_primary

object

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

dedicated_management_interface

object

cluster

object

device

Device

Name of the device for which interface is configured Required: YES.

string

>= 1 characters <= 64 characters

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node of the site.

string

>= 1 characters <= 64 characters

description

Interface Description

Description for this Interface.

string

>= 21 characters <= 256 characters

ethernet_interface

object

cluster

object

device

Device

Interface configuration for the ethernet device Required: YES.

string

>= 1 characters <= 64 characters

dhcp_client

object

dhcp_server

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP Networks

List of networks from which DHCP Server can allocate IPv4 Addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCP Network

DHCP network configuration.

object

dgw_address

Configured Address

Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.

string

<= 1024 characters

dns_address

Configured Address

Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Network Prefix

Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IP Range

DHCP pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.

string

<= 1024 characters

start_ip

Start IP

Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.

string

<= 1024 characters

exclude

Exclude

X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.

boolean format: boolean

same_as_dgw

object

network_prefix_allocator

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

fixed_ip_map

Fixed IP Assignments

Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IP mapping

Specify static IPv4 addresses per site:node.

object

ipv6_auto_config

object

host

object

router

object

dns_config

object

configured_list

object

dns_list

Dns List

List of IPv6 Addresses acting as DNS servers Required: YES.

Array<string>

>= 1 items <= 4 items

local_dns

object

configured_address

Configured Address

Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Prefix Info

Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.

string

<= 1024 characters

stateful

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP IPV6 Networks

List of networks from which DHCP server can allocate IP addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCPIPV6NetworkType

DHCP IPv6 network type configuration.

object

network_prefix

Network Prefix

Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IPV6 Range

DHCP IPv6 pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.

string

<= 1024 characters

start_ip

Start IPV6

Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.

string

<= 1024 characters

fixed_ip_map

Fixed IPV6 Assignments

Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IPV6 mapping

Map of Site:Node to IPv6 address.

object

is_primary

object

monitor

object

monitor_disabled

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

no_ipv6_address

object

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node.

string

>= 1 characters <= 64 characters

not_primary

object

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

site_local_inside_network

object

site_local_network

object

static_ip

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

static_ipv6_address

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

storage_network

object

untagged

object

vlan_id

VLAN Id

Exclusive with [untagged] Configure a VLAN tagged ethernet interface.

integer format: int64

>= 1 <= 4094

labels

Interface labels

Add Labels for this Interface, these labels can be used in firewall policy.

object

tunnel_interface

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

node

Node

Exclusive with [] Configuration will apply to a given device on the given node.

string

>= 1 characters <= 64 characters

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

site_local_inside_network

object

site_local_network

object

static_ip

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

tunnel

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

no_forward_proxy

object

no_global_network

object

no_network_policy

object

outside_nameserver

outside_nameserver

Optional DNS server V4 IP to be used for name resolution in local network.

string

<= 1024 characters

outside_vip

Common V4 VIP

Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network.

string

<= 1024 characters

site_to_site_tunnel_ip

Site Mesh Group Connection Via Virtual Ip

Exclusive with [sm_connection_public_ip sm_connection_pvt_ip] Site Mesh Group Connection Via Virtual IP. This option will use the Virtual IP provided for creating IPsec between two sites which are part of the site mesh group.

string

<= 1024 characters

sli_config

object

no_static_routes

object

no_v6_static_routes

object

static_routes

object

static_routes

static_routes

List of static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 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

node

Node

Node name on this site.

string

<= 1024 characters

static_v6_routes

object

static_routes

static_routes

List of IPv6 static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static IPv6 Route

Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IPv6 Prefixes

List of IPv6 route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

slo_config

object

dc_cluster_group

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

labels

Network labels

Add Labels for this network, these labels can be used in firewall policy.

object

no_dc_cluster_group

object

no_static_routes

object

no_static_v6_routes

object

static_routes

object

static_routes

static_routes

List of static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

static_v6_routes

object

static_routes

static_routes

List of IPv6 static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static IPv6 Route

Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IPv6 Prefixes

List of IPv6 route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

sm_connection_public_ip

object

sm_connection_pvt_ip

object

tunnel_dead_timeout

tunnel_dead_timeout

Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.

integer format: int64

vip_vrrp_mode

string

default: VIP_VRRP_INVALID

Allowed values: VIP_VRRP_INVALID VIP_VRRP_ENABLE VIP_VRRP_DISABLE

custom_storage_config

object

default_storage_class

object

no_static_routes

object

no_storage_device

object

no_storage_interfaces

object

static_routes

object

static_routes

static_routes

List of static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

storage_class_list

object

storage_classes

List of Storage Classes

List of custom storage classes.

Array<object>

<= 4 items

Custom Storage Class

Configuration of custom storage class.

object

advanced_storage_parameters

Advanced Parameters

Map of parameter name and string value.

object

allow_volume_expansion

Allow Volume Expansion

Allow volume expansion.

boolean format: boolean

custom_storage

object

yaml

Storage Class YAML

K8s YAML for StorageClass.

string

<= 4096 characters

default_storage_class

Default Storage Class

Make this storage class default storage class for the K8s cluster.

boolean format: boolean

description

Storage Class Description

Description for this storage class.

string

>= 21 characters <= 256 characters

hpe_storage

object

allow_mutations

allowMutations

Mutation can override specified parameters.

string

<= 256 characters

allow_overrides

allowOverrides

PVC can override specified parameters.

string

<= 256 characters

dedupe_enabled

dedupeEnabled

Indicates that the volume should enable deduplication.

boolean format: boolean

description

Description

The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.

string

>= 21 characters <= 512 characters

destroy_on_delete

destroyOnDelete

Indicates the backing Nimble volume (including snapshots) should be destroyed when the PVC is deleted.

boolean format: boolean

encrypted

encrypted

Indicates that the volume should be encrypted.

boolean format: boolean

folder

folder

The name of the folder in which to place the volume.

string

<= 128 characters

limit_iops

limitIops

The IOPS limit of the volume.

string format: int64

<= 1024 characters

limit_mbps

limitMbps

The IOPS limit of the volume.

string format: int64

<= 1024 characters

performance_policy

performancePolicy

The name of the performance policy to assign to the volume.

string

<= 128 characters

pool

pool

The name of the pool in which to place the volume.

string

<= 128 characters

protection_template

protectionTemplate

The name of the performance policy to assign to the volume.

string

<= 128 characters

secret_name

Secret Name

The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.

string

<= 256 characters

secret_namespace

Secret Namespace

The SecretNamespace parameter is used to identify name of namespace where secret resides.

string

<= 256 characters

sync_on_detach

syncOnDetach

Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node.

boolean format: boolean

thick

thick

Indicates that the volume should be thick provisioned.

boolean format: boolean

netapp_trident

object

selector

Selector

Using the Selector field, each StorageClass calls out which virtual pool(s) may be used to host a volume. The volume will have the aspects defined in the chosen virtual pool.

object

storage_pools

Storage Pools

The storagePools parameter is used to further restrict the set of pools that match any specified attributes.

string

<= 512 characters

pure_service_orchestrator

object

backend

Backend

Defines type of Pure storage backend block or file. The volume will have the aspects defined in the chosen virtual pool.

string

<= 1024 characters

bandwidth_limit

Bandwidth Limit

It must be between 1 MB/s and 512 GB/s. Enter the size as a number (bytes must be multiple of 512) or number with a single character unit symbol. Valid unit symbols are K, M, G, representing KiB, MiB, and GiB.

string

<= 12 characters

iops_limit

IOPS Limit

Enable IOPS limitation. It must be between 100 and 100 million. If value is 0, IOPS limit is not defined.

integer format: int64

reclaim_policy

Reclaim Policy

Reclaim Policy.

string

<= 16 characters

storage_class_name

Storage Class Name

Name of the storage class as it will appear in K8s. Required: YES.

string

<= 1024 characters

storage_device

Storage Device

Storage device that this class will use. The Device name defined at previous step. Required: YES.

string

>= 1 characters <= 64 characters

storage_device_list

object

storage_devices

List of Storage Devices

List of custom storage devices.

Array<object>

<= 4 items

Storage Device

Configuration of storage device.

object

advanced_advanced_parameters

Advanced Parameters

Map of parameter name and string value.

object

custom_storage

object

hpe_storage

object

api_server_port

Storage server Port

Enter Storage Server Port.

integer format: int64

iscsi_chap_password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

iscsi_chap_user

iscsi chapUser

Chap Username to connect to the HPE storage.

string

<= 256 characters

password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

storage_server_ip_address

Storage Server IP address

Enter storage server IP address.

string

<= 1024 characters

storage_server_name

Storage Server Name

Enter storage server Name.

string

<= 1024 characters

username

Username

Username to connect to the HPE storage management IP Required: YES.

string

>= 1 characters <= 256 characters

netapp_trident

object

netapp_backend_ontap_nas

object

auto_export_cidrs

object

prefixes

ipv4 prefix list

List of IPv4 prefixes that represent an endpoint.

Array<string>

<= 128 items

auto_export_policy

Auto Export Policy

Enable automatic export policy creation and updating.

boolean format: boolean

backend_name

Storage Backend Name

Configuration of Backend Name. Driver is name + ”_” + dataLIF.

string

>= 1 characters <= 50 characters

client_certificate

Client Certificate

Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.

string

<= 8192 characters

client_private_key

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

data_lif_dns_name

Backend Data LIF Name

Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

data_lif_ip

Backend Data LIF IP Address

Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

labels

Backend Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.

object

limit_aggregate_usage

Limit Aggregate Usage

Fail provisioning if usage is above this percentage. Not enforced by default.

string

<= 1024 characters

limit_volume_size

Limit Volume Size

Fail provisioning if requested volume size is above this value. Not enforced by default.

string

<= 1024 characters

management_lif_dns_name

Backend Management LIF Name

Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

management_lif_ip

Backend Management LIF IP Address

Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

nfs_mount_options

NFS Mount Options

Comma-separated list of NFS mount OPTIONS. Not enforced by default.

string

<= 1024 characters

password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

region

Backend Region

Virtual Pool Region.

string

<= 1024 characters

storage

Virtual Storage Pools

List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.

Array<object>

<= 8 items

Backend ONTAP Virtual Storage Pool

ONTAP Virtual Storage Pool definition.

object

labels

Storage Pool Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.

object

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

zone

Pool Zone

Virtual Storage Pool zone definition.

string

<= 1024 characters

storage_driver_name

Storage Backend Driver

Configuration of Backend Name Required: YES.

string

<= 1024 characters

storage_prefix

Storage Prefix

Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.

string

<= 1024 characters

svm

Backend SVM

Storage virtual machine to use. Derived if an SVM managementLIF is specified.

string

>= 1 characters <= 256 characters

trusted_ca_certificate

Trusted CA Certificate

Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..

string

<= 8192 characters

username

Username

Username to connect to the cluster/SVM Required: YES.

string

>= 1 characters <= 256 characters

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

netapp_backend_ontap_san

object

client_certificate

Client Certificate

Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.

string

<= 8192 characters

client_private_key

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

data_lif_dns_name

Backend Data LIF Name

Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

data_lif_ip

Backend Data LIF IP Address

Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

igroup_name

iGroup Name

Name of the igroup for SAN volumes to use.

string

>= 1 characters <= 256 characters

labels

Backend Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.

object

limit_aggregate_usage

Limit Aggregate Usage

Fail provisioning if usage is above this percentage. Not enforced by default.

integer format: int64

limit_volume_size

Limit Volume Size

Fail provisioning if requested volume size in GBi is above this value. Not enforced by default.

integer format: int32

management_lif_dns_name

Backend Management LIF Name

Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

management_lif_ip

Backend Management LIF IP Address

Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

no_chap

object

password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

region

Backend Region

Virtual Pool Region.

string

<= 1024 characters

storage

Virtual Storage Pools

List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.

Array<object>

<= 8 items

Backend ONTAP Virtual Storage Pool

ONTAP Virtual Storage Pool definition.

object

labels

Storage Pool Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.

object

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

zone

Pool Zone

Virtual Storage Pool zone definition.

string

<= 1024 characters

storage_driver_name

Storage Backend Driver

Configuration of Backend Name Required: YES.

string

<= 1024 characters

storage_prefix

Storage Prefix

Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.

string

>= 1 characters <= 80 characters

svm

Backend SVM

Storage virtual machine to use. Derived if an SVM managementLIF is specified.

string

>= 1 characters <= 256 characters

trusted_ca_certificate

Trusted CA Certificate

Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..

string

<= 8192 characters

use_chap

object

chap_initiator_secret

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

chap_target_initiator_secret

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

chap_target_username

CHAP Target Username

Target username. Required if useCHAP=true.

string

>= 1 characters <= 256 characters

chap_username

CHAP Username

Inbound username. Required if useCHAP=true.

string

>= 1 characters <= 256 characters

username

Username

Username to connect to the cluster/SVM Required: YES.

string

>= 1 characters <= 256 characters

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

pure_service_orchestrator

object

arrays

object

flash_array

object

default_fs_opt

Default Filesystem Options

Block volume default mkfs OPTIONS. Not recommended to change!

string

>= 1 characters <= 128 characters

default_fs_type

Default Filesystem Type

Block volume default filesystem type. Not recommended to change! Required: YES.

string

<= 1024 characters

default_mount_opts

Default Mount Options

Block volume default filesystem mount OPTIONS. Not recommended to change!

Array<string>

<= 4 items

disable_preempt_attachments

Disable Preempt Attachments

Enable/Disable attachment preemption!

boolean format: boolean

flash_arrays

Flash Arrays

For FlashArrays you must set the “mgmt_endpoint” and “api_token”

Required: YES.

Array<object>

>= 1 items <= 8 items

Flash Array Endpoint

For FlashArrays you must set the “mgmt_endpoint” and “api_token”

object

api_token

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

labels

Labels

The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.

object

mgmt_dns_name

dns_name

Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

mgmt_ip

Management Endpoint IP Address

Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.

string

<= 1024 characters

iscsi_login_timeout

iSCSI Login Timeout

ISCSI login timeout in seconds. Not recommended to change! Required: YES.

integer format: int32

san_type

SAN Type

Block volume access protocol, either ISCSI or FC Required: YES.

string

<= 1024 characters

flash_blade

object

enable_snapshot_directory

Enable Snapshot Directory

Enable/Disable FlashBlade snapshots.

boolean format: boolean

export_rules

NFS Export Rules

NFS Export rules.

string

>= 1 characters <= 250 characters

flash_blades

Flash Blades

For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint

Required: YES.

Array<object>

>= 1 items <= 8 items

Flash Blade Endpoint

For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint.

object

api_token

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

mgmt_dns_name

dns_name

Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

mgmt_ip

Management Endpoint IP Address

Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.

string

<= 1024 characters

nfs_endpoint_dns_name

NFS DNS Name

Exclusive with [nfs_endpoint_ip] Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

nfs_endpoint_ip

NFS IP Address

Exclusive with [nfs_endpoint_dns_name] Endpoint is reachable at the given IP address.

string

<= 1024 characters

labels

Labels

The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.

object

cluster_id

Cluster ID

ClusterID is added as a prefix for all volumes created by this PSO installation. ClusterID is also used to identify the volumes used by the datastore, pso-db. ClusterID MUST BE UNIQUE for multiple K8s clusters running on top of the same storage arrays. Characters allowed: alphanumeric and underscores Required: YES.

string

>= 1 characters <= 22 characters

enable_storage_topology

Enable Storage Topology

This option is to enable/disable the csi topology feature for pso-csi.

boolean format: boolean

enable_strict_topology

Enable Strict Topology

This option is to enable/disable the strict csi topology feature for pso-csi.

boolean format: boolean

storage_device

Storage Device

Storage device and device unit Required: YES.

string

<= 64 characters

storage_interface_list

object

storage_interfaces

List of Interfaces

Configure storage interfaces for this App Stack site

Required: YES.

Array<object>

>= 1 items <= 256 items

Storage Interfaces

Configure storage interface for this App Stack site.

object

description

Interface Description

Description for this Interface.

string

>= 21 characters <= 256 characters

labels

Interface labels

Add Labels for this Interface, these labels can be used in firewall policy.

object

storage_interface

object

cluster

object

device

Device

Interface configuration for the ethernet device Required: YES.

string

>= 1 characters <= 64 characters

dhcp_client

object

dhcp_server

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP Networks

List of networks from which DHCP Server can allocate IPv4 Addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCP Network

DHCP network configuration.

object

dgw_address

Configured Address

Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.

string

<= 1024 characters

dns_address

Configured Address

Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Network Prefix

Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IP Range

DHCP pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.

string

<= 1024 characters

start_ip

Start IP

Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.

string

<= 1024 characters

exclude

Exclude

X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.

boolean format: boolean

same_as_dgw

object

network_prefix_allocator

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

fixed_ip_map

Fixed IP Assignments

Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IP mapping

Specify static IPv4 addresses per site:node.

object

ipv6_auto_config

object

host

object

router

object

dns_config

object

configured_list

object

dns_list

Dns List

List of IPv6 Addresses acting as DNS servers Required: YES.

Array<string>

>= 1 items <= 4 items

local_dns

object

configured_address

Configured Address

Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Prefix Info

Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.

string

<= 1024 characters

stateful

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP IPV6 Networks

List of networks from which DHCP server can allocate IP addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCPIPV6NetworkType

DHCP IPv6 network type configuration.

object

network_prefix

Network Prefix

Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IPV6 Range

DHCP IPv6 pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.

string

<= 1024 characters

start_ip

Start IPV6

Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.

string

<= 1024 characters

fixed_ip_map

Fixed IPV6 Assignments

Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IPV6 mapping

Map of Site:Node to IPv6 address.

object

is_primary

object

monitor

object

monitor_disabled

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

no_ipv6_address

object

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node.

string

>= 1 characters <= 64 characters

not_primary

object

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

site_local_inside_network

object

site_local_network

object

static_ip

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

static_ipv6_address

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

storage_network

object

untagged

object

vlan_id

VLAN Id

Exclusive with [untagged] Configure a VLAN tagged ethernet interface.

integer format: int64

>= 1 <= 4094

default_blocked_services

object

default_network_config

object

default_sriov_interface

object

default_storage_config

object

deny_all_usb

object

disable_gpu

object

disable_vm

object

enable_gpu

object

enable_vgpu

object

feature_type

string

default: UNLICENSED

Allowed values: UNLICENSED VGPU VWS VCS

server_address

License Server Address

Set License Server Address.

string

<= 1024 characters

server_port

License Server Port Number

Set License Server port number.

integer format: int64

enable_vm

object

k8s_cluster

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

kubernetes_upgrade_drain

object

disable_upgrade_drain

object

enable_upgrade_drain

object

disable_vega_upgrade_mode

object

drain_max_unavailable_node_count

Node Batch Size Count

Exclusive with []

integer format: int64

drain_node_timeout

Upgrade Wait Time

Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes. (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is recommended to use the default value).

Required: YES.

integer format: int64

enable_vega_upgrade_mode

object

local_control_plane

object

bgp_config

object

asn

ASN

Autonomous System Number Required: YES.

integer format: int64

peers

BGP Peers

BGP parameters for peer.

Array<object>

<= 8 items

Peer

BGP Peer parameters.

object

bfd_disabled

object

bfd_enabled

object

multiplier

Multiplier

Specify Number of missed packets to bring session down” Required: YES.

integer format: int64

receive_interval_milliseconds

Receive Interval in milliseconds

BFD receive interval timer, in milliseconds Required: YES.

integer format: int64

transmit_interval_milliseconds

Transmit Interval in milliseconds

BFD transmit interval timer, in milliseconds Required: YES.

integer format: int64

disable

object

external

object

address

address

Exclusive with [default_gateway disable external_connector from_site subnet_begin_offset subnet_end_offset] Specify IPv4 peer address.

string

<= 1024 characters

address_ipv6

address_ipv6

Exclusive with [default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6 subnet_end_offset_v6] Specify peer IPv6 address.

string

<= 1024 characters

asn

ASN

Autonomous System Number for BGP peer Required: YES.

integer format: int64

default_gateway

object

default_gateway_v6

object

disable

object

disable_v6

object

external_connector

object

family_inet

object

disable

object

enable

object

from_site

object

from_site_v6

object

interface

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

interface_list

object

interfaces

interface_list

List of network interfaces.

Required: YES.

Array<object>

>= 1 items <= 16 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

md5_auth_key

md5_auth_key

Exclusive with [no_authentication] MD5 key for protecting BGP Sessions (RFC 2385)

string

<= 1024 characters

no_authentication

object

port

Peer Port

Peer TCP port number.

integer format: int64

>= 1 <= 65535

subnet_begin_offset

subnet_begin_offset

Exclusive with [address default_gateway disable external_connector from_site subnet_end_offset] Calculate peer address using offset from the beginning of the subnet.

integer format: int64

subnet_begin_offset_v6

subnet_begin_offset_v6

Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_end_offset_v6] Calculate peer address using offset from the beginning of the subnet.

integer format: int64

subnet_end_offset

subnet_end_offset

Exclusive with [address default_gateway disable external_connector from_site subnet_begin_offset] Calculate peer address using offset from the end of the subnet.

integer format: int64

subnet_end_offset_v6

subnet_end_offset_v6

Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6] Calculate peer address using offset from the end of the subnet.

integer format: int64

label

label

Specify whether this peer should be.

string

<= 1024 characters

metadata

object

description

description

Human readable description.

string

>= 21 characters <= 256 characters

name

name

This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 1 characters <= 1024 characters

passive_mode_disabled

object

passive_mode_enabled

object

routing_policies

object

route_policy

route_policy

Route policy to be applied.

Array<object>

<= 4 items

BGP Route policy

List of filter rules which can be applied on all or particular nodes.

object

all_nodes

object

inbound

object

node_name

object

node

Node

Select BGP Session on which policy will be applied.

Array<string>

object_refs

Policy to apply

Select route policy to apply.

Required: YES.

Array<object>

>= 1 items <= 1 items

ObjectRefType

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

outbound

object

inside_vn

object

outside_vn

object

log_receiver

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

logs_streaming_disabled

object

master_node_configuration

Configuration of master nodes

Required: YES.

Array<object>

<= 3 items

Master Node

Master Node is the configuration of the master node.

object

name

Name

Names of master node Required: YES.

string

>= 6 characters <= 1024 characters

public_ip

Public IP

IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group.

string

<= 1024 characters

no_bond_devices

object

no_k8s_cluster

object

no_local_control_plane

object

offline_survivability_mode

object

enable_offline_survivability_mode

object

no_offline_survivability_mode

object

default_os_version

object

operating_system_version

Operating System Version

Exclusive with [default_os_version] Specify a OS version to be used e.g. 9.2024.6.

string

<= 20 characters

sriov_interfaces

object

sriov_interface

Custom SR-IOV interfaces Configuration

Use custom SR-IOV interfaces Configuration.

Array<object>

SriovInterface specifies the configuration fo SR-IOV interfaces and how many virtual functions it has

Single Root I/O Virtualization interfaces configured explicitly By default no SR-IOV interface is assigned to the fleet.

object

interface_name

interface_name

Name of SR-IOV physical interface Required: YES.

string

<= 1024 characters

number_of_vfio_vfs

number_of_vfio_vfs

Number of virtual functions reserved for VNFs and DPDK-based CNFs.

integer format: int64

number_of_vfs

number_of_vfs

Total number of virtual functions Required: YES.

integer format: int64

object

default_sw_version

object

volterra_software_version

F5XC Software Version

Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g. Crt-20210329-1002.

string

<= 20 characters

usb_policy

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

volterra_certified_hw

Name for generic server certified hardware to form this App Stack site. Required: YES.

string

>= 1 characters <= 1024 characters

worker_nodes

Names of worker nodes.

Array<string>

<= 128 items

deleted_referred_objects

deleted_referred_objects

The set of deleted objects that are referred by this object.

Array<object>

ObjectRefType

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

disabled_referred_objects

disabled_referred_objects

The set of deleted objects that are referred by this object.

Array<object>

ObjectRefType

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

metadata

object

annotations

annotations

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

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

referring_objects

referring_objects

The set of objects that are referring to this object in their spec.

Array<object>

ObjectRefType

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

replace_form

object

metadata

object

annotations

annotations

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

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

spec

object

address

Site’s geographical address that can be used to determine its latitude and longitude.

string

<= 256 characters

allow_all_usb

object

blocked_services

object

blocked_sevice

Disable Node Local Services

Blocking or denial configuration

Array<object>

Disable Node Local Service

Disable a node local service on this site.

object

dns

object

network_type

string

default: VIRTUAL_NETWORK_SITE_LOCAL

ssh

object

web_user_interface

object

bond_device_list

object

bond_devices

Bond Devices List

List of bond devices

Required: YES.

Array<object>

>= 1 items <= 4 items

Bond Device

Bond devices configuration for fleet.

object

active_backup

object

devices

Member Ethernet Devices

Ethernet devices that will make up this bond Required: YES.

Array<string>

>= 1 items <= 8 items

lacp

object

rate

Interval

Interval in seconds to transmit LACP packets.

integer format: int64

link_polling_interval

Link Polling Interval

Link polling interval in milliseconds Required: YES.

integer format: int64

link_up_delay

Link Up Delay

Milliseconds wait before link is declared up Required: YES.

integer format: int64

name

Bond Device

Name for the Bond. Ex ‘bond0’ Required: YES.

string

>= 6 characters <= 64 characters

coordinates

object

latitude

latitude

Latitude of the site location.

number format: float

longitude

longitude

Longitude of site location.

number format: float

custom_dns

object

inside_nameserver

inside_nameserver

Optional DNS server IP to be used for name resolution in inside network.

string

<= 1024 characters

outside_nameserver

outside_nameserver

Optional DNS server IP to be used for name resolution in outside network.

string

<= 1024 characters

custom_network_config

object

active_enhanced_firewall_policies

object

enhanced_firewall_policies

Enhanced Firewall Policy

Ordered List of Enhanced Firewall Policies active

Required: YES.

Array<object>

>= 1 items <= 128 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

active_forward_proxy_policies

object

forward_proxy_policies

Forward Proxy Policies

Ordered List of Forward Proxy Policies active

Required: YES.

Array<object>

>= 1 items <= 128 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

active_network_policies

object

network_policies

Firewall Policy

Ordered List of Firewall Policies active for this network firewall

Required: YES.

Array<object>

>= 1 items <= 128 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

bgp_peer_address

bgp_peer_address

string

<= 1024 characters

bgp_router_id

bgp_router_id

Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object.

string

<= 1024 characters

default_config

object

default_interface_config

object

default_sli_config

object

forward_proxy_allow_all

object

global_network_list

object

global_network_connections

Global Network Connections

Global network connections

Required: YES.

Array<object>

>= 1 items <= 8 items

Global Network Connection

Global network connection.

object

sli_to_global_dr

object

global_vn

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

slo_to_global_dr

object

global_vn

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

interface_list

object

interfaces

List of Interfaces

Configure network interfaces for this App Stack site

Required: YES.

Array<object>

>= 1 items <= 128 items

Interface

Interface definition.

object

dc_cluster_group_connectivity_interface_disabled

object

dc_cluster_group_connectivity_interface_enabled

object

dedicated_interface

object

cluster

object

device

Device

Name of the device for which interface is configured. Use wwan0 for 4G/LTE. Required: YES.

string

>= 1 characters <= 64 characters

is_primary

object

monitor

object

monitor_disabled

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node of the site.

string

>= 1 characters <= 64 characters

not_primary

object

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

dedicated_management_interface

object

cluster

object

device

Device

Name of the device for which interface is configured Required: YES.

string

>= 1 characters <= 64 characters

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node of the site.

string

>= 1 characters <= 64 characters

description

Interface Description

Description for this Interface.

string

>= 21 characters <= 256 characters

ethernet_interface

object

cluster

object

device

Device

Interface configuration for the ethernet device Required: YES.

string

>= 1 characters <= 64 characters

dhcp_client

object

dhcp_server

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP Networks

List of networks from which DHCP Server can allocate IPv4 Addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCP Network

DHCP network configuration.

object

dgw_address

Configured Address

Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.

string

<= 1024 characters

dns_address

Configured Address

Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Network Prefix

Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IP Range

DHCP pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.

string

<= 1024 characters

start_ip

Start IP

Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.

string

<= 1024 characters

exclude

Exclude

X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.

boolean format: boolean

same_as_dgw

object

network_prefix_allocator

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

fixed_ip_map

Fixed IP Assignments

Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IP mapping

Specify static IPv4 addresses per site:node.

object

ipv6_auto_config

object

host

object

router

object

dns_config

object

configured_list

object

dns_list

Dns List

List of IPv6 Addresses acting as DNS servers Required: YES.

Array<string>

>= 1 items <= 4 items

local_dns

object

configured_address

Configured Address

Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Prefix Info

Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.

string

<= 1024 characters

stateful

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP IPV6 Networks

List of networks from which DHCP server can allocate IP addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCPIPV6NetworkType

DHCP IPv6 network type configuration.

object

network_prefix

Network Prefix

Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IPV6 Range

DHCP IPv6 pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.

string

<= 1024 characters

start_ip

Start IPV6

Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.

string

<= 1024 characters

fixed_ip_map

Fixed IPV6 Assignments

Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IPV6 mapping

Map of Site:Node to IPv6 address.

object

is_primary

object

monitor

object

monitor_disabled

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

no_ipv6_address

object

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node.

string

>= 1 characters <= 64 characters

not_primary

object

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

site_local_inside_network

object

site_local_network

object

static_ip

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

static_ipv6_address

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

storage_network

object

untagged

object

vlan_id

VLAN Id

Exclusive with [untagged] Configure a VLAN tagged ethernet interface.

integer format: int64

>= 1 <= 4094

labels

Interface labels

Add Labels for this Interface, these labels can be used in firewall policy.

object

tunnel_interface

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

node

Node

Exclusive with [] Configuration will apply to a given device on the given node.

string

>= 1 characters <= 64 characters

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

site_local_inside_network

object

site_local_network

object

static_ip

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

tunnel

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

no_forward_proxy

object

no_global_network

object

no_network_policy

object

outside_nameserver

outside_nameserver

Optional DNS server V4 IP to be used for name resolution in local network.

string

<= 1024 characters

outside_vip

Common V4 VIP

Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network.

string

<= 1024 characters

site_to_site_tunnel_ip

Site Mesh Group Connection Via Virtual Ip

string

<= 1024 characters

sli_config

object

no_static_routes

object

no_v6_static_routes

object

static_routes

object

static_routes

static_routes

List of static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

static_v6_routes

object

static_routes

static_routes

List of IPv6 static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static IPv6 Route

Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IPv6 Prefixes

List of IPv6 route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

slo_config

object

dc_cluster_group

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

labels

Network labels

Add Labels for this network, these labels can be used in firewall policy.

object

no_dc_cluster_group

object

no_static_routes

object

no_static_v6_routes

object

static_routes

object

static_routes

static_routes

List of static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

static_v6_routes

object

static_routes

static_routes

List of IPv6 static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static IPv6 Route

Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IPv6 Prefixes

List of IPv6 route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

sm_connection_public_ip

object

sm_connection_pvt_ip

object

tunnel_dead_timeout

tunnel_dead_timeout

Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.

integer format: int64

vip_vrrp_mode

string

default: VIP_VRRP_INVALID

Allowed values: VIP_VRRP_INVALID VIP_VRRP_ENABLE VIP_VRRP_DISABLE

custom_storage_config

object

default_storage_class

object

no_static_routes

object

no_storage_device

object

no_storage_interfaces

object

static_routes

object

static_routes

static_routes

List of static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

storage_class_list

object

storage_classes

List of Storage Classes

List of custom storage classes.

Array<object>

<= 4 items

Custom Storage Class

Configuration of custom storage class.

object

advanced_storage_parameters

Advanced Parameters

Map of parameter name and string value.

object

allow_volume_expansion

Allow Volume Expansion

Allow volume expansion.

boolean format: boolean

custom_storage

object

yaml

Storage Class YAML

K8s YAML for StorageClass.

string

<= 4096 characters

default_storage_class

Default Storage Class

Make this storage class default storage class for the K8s cluster.

boolean format: boolean

description

Storage Class Description

Description for this storage class.

string

>= 21 characters <= 256 characters

hpe_storage

object

allow_mutations

allowMutations

Mutation can override specified parameters.

string

<= 256 characters

allow_overrides

allowOverrides

PVC can override specified parameters.

string

<= 256 characters

dedupe_enabled

dedupeEnabled

Indicates that the volume should enable deduplication.

boolean format: boolean

description

Description

The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.

string

>= 21 characters <= 512 characters

destroy_on_delete

destroyOnDelete

Indicates the backing Nimble volume (including snapshots) should be destroyed when the PVC is deleted.

boolean format: boolean

encrypted

encrypted

Indicates that the volume should be encrypted.

boolean format: boolean

folder

folder

The name of the folder in which to place the volume.

string

<= 128 characters

limit_iops

limitIops

The IOPS limit of the volume.

string format: int64

<= 1024 characters

limit_mbps

limitMbps

The IOPS limit of the volume.

string format: int64

<= 1024 characters

performance_policy

performancePolicy

The name of the performance policy to assign to the volume.

string

<= 128 characters

pool

pool

The name of the pool in which to place the volume.

string

<= 128 characters

protection_template

protectionTemplate

The name of the performance policy to assign to the volume.

string

<= 128 characters

secret_name

Secret Name

The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.

string

<= 256 characters

secret_namespace

Secret Namespace

The SecretNamespace parameter is used to identify name of namespace where secret resides.

string

<= 256 characters

sync_on_detach

syncOnDetach

Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node.

boolean format: boolean

thick

thick

Indicates that the volume should be thick provisioned.

boolean format: boolean

netapp_trident

object

selector

Selector

Using the Selector field, each StorageClass calls out which virtual pool(s) may be used to host a volume. The volume will have the aspects defined in the chosen virtual pool.

object

storage_pools

Storage Pools

The storagePools parameter is used to further restrict the set of pools that match any specified attributes.

string

<= 512 characters

pure_service_orchestrator

object

backend

Backend

Defines type of Pure storage backend block or file. The volume will have the aspects defined in the chosen virtual pool.

string

<= 1024 characters

bandwidth_limit

Bandwidth Limit

string

<= 12 characters

iops_limit

IOPS Limit

Enable IOPS limitation. It must be between 100 and 100 million. If value is 0, IOPS limit is not defined.

integer format: int64

reclaim_policy

Reclaim Policy

Reclaim Policy.

string

<= 16 characters

storage_class_name

Storage Class Name

Name of the storage class as it will appear in K8s. Required: YES.

string

<= 1024 characters

storage_device

Storage Device

Storage device that this class will use. The Device name defined at previous step. Required: YES.

string

>= 1 characters <= 64 characters

storage_device_list

object

storage_devices

List of Storage Devices

List of custom storage devices.

Array<object>

<= 4 items

Storage Device

Configuration of storage device.

object

advanced_advanced_parameters

Advanced Parameters

Map of parameter name and string value.

object

custom_storage

object

hpe_storage

object

api_server_port

Storage server Port

Enter Storage Server Port.

integer format: int64

iscsi_chap_password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

iscsi_chap_user

iscsi chapUser

Chap Username to connect to the HPE storage.

string

<= 256 characters

password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

storage_server_ip_address

Storage Server IP address

Enter storage server IP address.

string

<= 1024 characters

storage_server_name

Storage Server Name

Enter storage server Name.

string

<= 1024 characters

username

Username

Username to connect to the HPE storage management IP Required: YES.

string

>= 1 characters <= 256 characters

netapp_trident

object

netapp_backend_ontap_nas

object

auto_export_cidrs

object

prefixes

ipv4 prefix list

List of IPv4 prefixes that represent an endpoint.

Array<string>

<= 128 items

auto_export_policy

Auto Export Policy

Enable automatic export policy creation and updating.

boolean format: boolean

backend_name

Storage Backend Name

Configuration of Backend Name. Driver is name + ”_” + dataLIF.

string

>= 1 characters <= 50 characters

client_certificate

Client Certificate

Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.

string

<= 8192 characters

client_private_key

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

data_lif_dns_name

Backend Data LIF Name

Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

data_lif_ip

Backend Data LIF IP Address

Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

labels

Backend Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.

object

limit_aggregate_usage

Limit Aggregate Usage

Fail provisioning if usage is above this percentage. Not enforced by default.

string

<= 1024 characters

limit_volume_size

Limit Volume Size

Fail provisioning if requested volume size is above this value. Not enforced by default.

string

<= 1024 characters

management_lif_dns_name

Backend Management LIF Name

Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

management_lif_ip

Backend Management LIF IP Address

Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

nfs_mount_options

NFS Mount Options

Comma-separated list of NFS mount OPTIONS. Not enforced by default.

string

<= 1024 characters

password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

region

Backend Region

Virtual Pool Region.

string

<= 1024 characters

storage

Virtual Storage Pools

List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.

Array<object>

<= 8 items

Backend ONTAP Virtual Storage Pool

ONTAP Virtual Storage Pool definition.

object

labels

Storage Pool Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.

object

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

zone

Pool Zone

Virtual Storage Pool zone definition.

string

<= 1024 characters

storage_driver_name

Storage Backend Driver

Configuration of Backend Name Required: YES.

string

<= 1024 characters

storage_prefix

Storage Prefix

Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.

string

<= 1024 characters

svm

Backend SVM

Storage virtual machine to use. Derived if an SVM managementLIF is specified.

string

>= 1 characters <= 256 characters

trusted_ca_certificate

Trusted CA Certificate

Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..

string

<= 8192 characters

username

Username

Username to connect to the cluster/SVM Required: YES.

string

>= 1 characters <= 256 characters

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

netapp_backend_ontap_san

object

client_certificate

Client Certificate

Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.

string

<= 8192 characters

client_private_key

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

data_lif_dns_name

Backend Data LIF Name

Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

data_lif_ip

Backend Data LIF IP Address

Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

igroup_name

iGroup Name

Name of the igroup for SAN volumes to use.

string

>= 1 characters <= 256 characters

labels

Backend Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.

object

limit_aggregate_usage

Limit Aggregate Usage

Fail provisioning if usage is above this percentage. Not enforced by default.

integer format: int64

limit_volume_size

Limit Volume Size

Fail provisioning if requested volume size in GBi is above this value. Not enforced by default.

integer format: int32

management_lif_dns_name

Backend Management LIF Name

Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

management_lif_ip

Backend Management LIF IP Address

Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

no_chap

object

password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

region

Backend Region

Virtual Pool Region.

string

<= 1024 characters

storage

Virtual Storage Pools

List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.

Array<object>

<= 8 items

Backend ONTAP Virtual Storage Pool

ONTAP Virtual Storage Pool definition.

object

labels

Storage Pool Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.

object

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

zone

Pool Zone

Virtual Storage Pool zone definition.

string

<= 1024 characters

storage_driver_name

Storage Backend Driver

Configuration of Backend Name Required: YES.

string

<= 1024 characters

storage_prefix

Storage Prefix

Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.

string

>= 1 characters <= 80 characters

svm

Backend SVM

Storage virtual machine to use. Derived if an SVM managementLIF is specified.

string

>= 1 characters <= 256 characters

trusted_ca_certificate

Trusted CA Certificate

Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..

string

<= 8192 characters

use_chap

object

chap_initiator_secret

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

chap_target_initiator_secret

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

chap_target_username

CHAP Target Username

Target username. Required if useCHAP=true.

string

>= 1 characters <= 256 characters

chap_username

CHAP Username

Inbound username. Required if useCHAP=true.

string

>= 1 characters <= 256 characters

username

Username

Username to connect to the cluster/SVM Required: YES.

string

>= 1 characters <= 256 characters

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

pure_service_orchestrator

object

arrays

object

flash_array

object

default_fs_opt

Default Filesystem Options

Block volume default mkfs OPTIONS. Not recommended to change!

string

>= 1 characters <= 128 characters

default_fs_type

Default Filesystem Type

Block volume default filesystem type. Not recommended to change! Required: YES.

string

<= 1024 characters

default_mount_opts

Default Mount Options

Block volume default filesystem mount OPTIONS. Not recommended to change!

Array<string>

<= 4 items

disable_preempt_attachments

Disable Preempt Attachments

Enable/Disable attachment preemption!

boolean format: boolean

flash_arrays

Flash Arrays

For FlashArrays you must set the “mgmt_endpoint” and “api_token”

Required: YES.

Array<object>

>= 1 items <= 8 items

Flash Array Endpoint

For FlashArrays you must set the “mgmt_endpoint” and “api_token”

object

api_token

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

labels

Labels

The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.

object

mgmt_dns_name

dns_name

Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

mgmt_ip

Management Endpoint IP Address

Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.

string

<= 1024 characters

iscsi_login_timeout

iSCSI Login Timeout

ISCSI login timeout in seconds. Not recommended to change! Required: YES.

integer format: int32

san_type

SAN Type

Block volume access protocol, either ISCSI or FC Required: YES.

string

<= 1024 characters

flash_blade

object

enable_snapshot_directory

Enable Snapshot Directory

Enable/Disable FlashBlade snapshots.

boolean format: boolean

export_rules

NFS Export Rules

NFS Export rules.

string

>= 1 characters <= 250 characters

flash_blades

Flash Blades

For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint

Required: YES.

Array<object>

>= 1 items <= 8 items

Flash Blade Endpoint

For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint.

object

api_token

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

mgmt_dns_name

dns_name

Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

mgmt_ip

Management Endpoint IP Address

Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.

string

<= 1024 characters

nfs_endpoint_dns_name

NFS DNS Name

Exclusive with [nfs_endpoint_ip] Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

nfs_endpoint_ip

NFS IP Address

Exclusive with [nfs_endpoint_dns_name] Endpoint is reachable at the given IP address.

string

<= 1024 characters

labels

Labels

The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.

object

cluster_id

Cluster ID

string

>= 1 characters <= 22 characters

enable_storage_topology

Enable Storage Topology

This option is to enable/disable the csi topology feature for pso-csi.

boolean format: boolean

enable_strict_topology

Enable Strict Topology

This option is to enable/disable the strict csi topology feature for pso-csi.

boolean format: boolean

storage_device

Storage Device

Storage device and device unit Required: YES.

string

<= 64 characters

storage_interface_list

object

storage_interfaces

List of Interfaces

Configure storage interfaces for this App Stack site

Required: YES.

Array<object>

>= 1 items <= 256 items

Storage Interfaces

Configure storage interface for this App Stack site.

object

description

Interface Description

Description for this Interface.

string

>= 21 characters <= 256 characters

labels

Interface labels

Add Labels for this Interface, these labels can be used in firewall policy.

object

storage_interface

object

cluster

object

device

Device

Interface configuration for the ethernet device Required: YES.

string

>= 1 characters <= 64 characters

dhcp_client

object

dhcp_server

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP Networks

List of networks from which DHCP Server can allocate IPv4 Addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCP Network

DHCP network configuration.

object

dgw_address

Configured Address

Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.

string

<= 1024 characters

dns_address

Configured Address

Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Network Prefix

Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IP Range

DHCP pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.

string

<= 1024 characters

start_ip

Start IP

Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.

string

<= 1024 characters

exclude

Exclude

X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.

boolean format: boolean

same_as_dgw

object

network_prefix_allocator

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

fixed_ip_map

Fixed IP Assignments

Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IP mapping

Specify static IPv4 addresses per site:node.

object

ipv6_auto_config

object

host

object

router

object

dns_config

object

configured_list

object

dns_list

Dns List

List of IPv6 Addresses acting as DNS servers Required: YES.

Array<string>

>= 1 items <= 4 items

local_dns

object

configured_address

Configured Address

Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Prefix Info

Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.

string

<= 1024 characters

stateful

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP IPV6 Networks

List of networks from which DHCP server can allocate IP addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCPIPV6NetworkType

DHCP IPv6 network type configuration.

object

network_prefix

Network Prefix

Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IPV6 Range

DHCP IPv6 pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.

string

<= 1024 characters

start_ip

Start IPV6

Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.

string

<= 1024 characters

fixed_ip_map

Fixed IPV6 Assignments

Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IPV6 mapping

Map of Site:Node to IPv6 address.

object

is_primary

object

monitor

object

monitor_disabled

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

no_ipv6_address

object

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node.

string

>= 1 characters <= 64 characters

not_primary

object

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

site_local_inside_network

object

site_local_network

object

static_ip

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

static_ipv6_address

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

storage_network

object

untagged

object

vlan_id

VLAN Id

Exclusive with [untagged] Configure a VLAN tagged ethernet interface.

integer format: int64

>= 1 <= 4094

default_blocked_services

object

default_network_config

object

default_sriov_interface

object

default_storage_config

object

deny_all_usb

object

disable_gpu

object

disable_vm

object

enable_gpu

object

enable_vgpu

object

feature_type

string

default: UNLICENSED

Allowed values: UNLICENSED VGPU VWS VCS

server_address

License Server Address

Set License Server Address.

string

<= 1024 characters

server_port

License Server Port Number

Set License Server port number.

integer format: int64

enable_vm

object

k8s_cluster

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

kubernetes_upgrade_drain

object

disable_upgrade_drain

object

enable_upgrade_drain

object

disable_vega_upgrade_mode

object

drain_max_unavailable_node_count

Node Batch Size Count

Exclusive with []

integer format: int64

drain_node_timeout

Upgrade Wait Time

Required: YES.

integer format: int64

enable_vega_upgrade_mode

object

local_control_plane

object

bgp_config

object

asn

ASN

Autonomous System Number Required: YES.

integer format: int64

peers

BGP Peers

BGP parameters for peer.

Array<object>

<= 8 items

Peer

BGP Peer parameters.

object

bfd_disabled

object

bfd_enabled

object

multiplier

Multiplier

Specify Number of missed packets to bring session down” Required: YES.

integer format: int64

receive_interval_milliseconds

Receive Interval in milliseconds

BFD receive interval timer, in milliseconds Required: YES.

integer format: int64

transmit_interval_milliseconds

Transmit Interval in milliseconds

BFD transmit interval timer, in milliseconds Required: YES.

integer format: int64

disable

object

external

object

address

address

Exclusive with [default_gateway disable external_connector from_site subnet_begin_offset subnet_end_offset] Specify IPv4 peer address.

string

<= 1024 characters

address_ipv6

address_ipv6

Exclusive with [default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6 subnet_end_offset_v6] Specify peer IPv6 address.

string

<= 1024 characters

asn

ASN

Autonomous System Number for BGP peer Required: YES.

integer format: int64

default_gateway

object

default_gateway_v6

object

disable

object

disable_v6

object

external_connector

object

family_inet

object

disable

object

enable

object

from_site

object

from_site_v6

object

interface

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

interface_list

object

interfaces

interface_list

List of network interfaces.

Required: YES.

Array<object>

>= 1 items <= 16 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

md5_auth_key

md5_auth_key

Exclusive with [no_authentication] MD5 key for protecting BGP Sessions (RFC 2385)

string

<= 1024 characters

no_authentication

object

port

Peer Port

Peer TCP port number.

integer format: int64

>= 1 <= 65535

subnet_begin_offset

subnet_begin_offset

Exclusive with [address default_gateway disable external_connector from_site subnet_end_offset] Calculate peer address using offset from the beginning of the subnet.

integer format: int64

subnet_begin_offset_v6

subnet_begin_offset_v6

Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_end_offset_v6] Calculate peer address using offset from the beginning of the subnet.

integer format: int64

subnet_end_offset

subnet_end_offset

Exclusive with [address default_gateway disable external_connector from_site subnet_begin_offset] Calculate peer address using offset from the end of the subnet.

integer format: int64

subnet_end_offset_v6

subnet_end_offset_v6

Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6] Calculate peer address using offset from the end of the subnet.

integer format: int64

label

label

Specify whether this peer should be.

string

<= 1024 characters

metadata

object

description

description

Human readable description.

string

>= 21 characters <= 256 characters

name

name

This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 1 characters <= 1024 characters

passive_mode_disabled

object

passive_mode_enabled

object

routing_policies

object

route_policy

route_policy

Route policy to be applied.

Array<object>

<= 4 items

BGP Route policy

List of filter rules which can be applied on all or particular nodes.

object

all_nodes

object

inbound

object

node_name

object

node

Node

Select BGP Session on which policy will be applied.

Array<string>

object_refs

Policy to apply

Select route policy to apply.

Required: YES.

Array<object>

>= 1 items <= 1 items

ObjectRefType

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

outbound

object

inside_vn

object

outside_vn

object

log_receiver

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

logs_streaming_disabled

object

master_node_configuration

Configuration of master nodes

Required: YES.

Array<object>

<= 3 items

Master Node

Master Node is the configuration of the master node.

object

name

Name

Names of master node Required: YES.

string

>= 6 characters <= 1024 characters

public_ip

Public IP

IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group.

string

<= 1024 characters

no_bond_devices

object

no_k8s_cluster

object

no_local_control_plane

object

offline_survivability_mode

object

enable_offline_survivability_mode

object

no_offline_survivability_mode

object

default_os_version

object

operating_system_version

Operating System Version

Exclusive with [default_os_version] Specify a OS version to be used e.g. 9.2024.6.

string

<= 20 characters

sriov_interfaces

object

sriov_interface

Custom SR-IOV interfaces Configuration

Use custom SR-IOV interfaces Configuration.

Array<object>

SriovInterface specifies the configuration fo SR-IOV interfaces and how many virtual functions it has

Single Root I/O Virtualization interfaces configured explicitly By default no SR-IOV interface is assigned to the fleet.

object

interface_name

interface_name

Name of SR-IOV physical interface Required: YES.

string

<= 1024 characters

number_of_vfio_vfs

number_of_vfio_vfs

Number of virtual functions reserved for VNFs and DPDK-based CNFs.

integer format: int64

number_of_vfs

number_of_vfs

Total number of virtual functions Required: YES.

integer format: int64

object

default_sw_version

object

volterra_software_version

F5XC Software Version

Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g. Crt-20210329-1002.

string

<= 20 characters

usb_policy

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

volterra_certified_hw

Name for generic server certified hardware to form this App Stack site. Required: YES.

string

>= 1 characters <= 1024 characters

worker_nodes

Names of worker nodes.

Array<string>

<= 128 items

spec

object

address

Site’s geographical address that can be used to determine its latitude and longitude.

string

<= 256 characters

allow_all_usb

object

blocked_services

object

blocked_sevice

Disable Node Local Services

Blocking or denial configuration

Array<object>

Disable Node Local Service

Disable a node local service on this site.

object

dns

object

network_type

string

default: VIRTUAL_NETWORK_SITE_LOCAL

ssh

object

web_user_interface

object

bond_device_list

object

bond_devices

Bond Devices List

List of bond devices

Required: YES.

Array<object>

>= 1 items <= 4 items

Bond Device

Bond devices configuration for fleet.

object

active_backup

object

devices

Member Ethernet Devices

Ethernet devices that will make up this bond Required: YES.

Array<string>

>= 1 items <= 8 items

lacp

object

rate

Interval

Interval in seconds to transmit LACP packets.

integer format: int64

link_polling_interval

Link Polling Interval

Link polling interval in milliseconds Required: YES.

integer format: int64

link_up_delay

Link Up Delay

Milliseconds wait before link is declared up Required: YES.

integer format: int64

name

Bond Device

Name for the Bond. Ex ‘bond0’ Required: YES.

string

>= 6 characters <= 64 characters

coordinates

object

latitude

latitude

Latitude of the site location.

number format: float

longitude

longitude

Longitude of site location.

number format: float

custom_dns

object

inside_nameserver

inside_nameserver

Optional DNS server IP to be used for name resolution in inside network.

string

<= 1024 characters

outside_nameserver

outside_nameserver

Optional DNS server IP to be used for name resolution in outside network.

string

<= 1024 characters

custom_network_config

object

active_enhanced_firewall_policies

object

enhanced_firewall_policies

Enhanced Firewall Policy

Ordered List of Enhanced Firewall Policies active

Required: YES.

Array<object>

>= 1 items <= 128 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

active_forward_proxy_policies

object

forward_proxy_policies

Forward Proxy Policies

Ordered List of Forward Proxy Policies active

Required: YES.

Array<object>

>= 1 items <= 128 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

active_network_policies

object

network_policies

Firewall Policy

Ordered List of Firewall Policies active for this network firewall

Required: YES.

Array<object>

>= 1 items <= 128 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

bgp_peer_address

bgp_peer_address

string

<= 1024 characters

bgp_router_id

bgp_router_id

Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object.

string

<= 1024 characters

default_config

object

default_interface_config

object

default_sli_config

object

forward_proxy_allow_all

object

global_network_list

object

global_network_connections

Global Network Connections

Global network connections

Required: YES.

Array<object>

>= 1 items <= 8 items

Global Network Connection

Global network connection.

object

sli_to_global_dr

object

global_vn

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

slo_to_global_dr

object

global_vn

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

interface_list

object

interfaces

List of Interfaces

Configure network interfaces for this App Stack site

Required: YES.

Array<object>

>= 1 items <= 128 items

Interface

Interface definition.

object

dc_cluster_group_connectivity_interface_disabled

object

dc_cluster_group_connectivity_interface_enabled

object

dedicated_interface

object

cluster

object

device

Device

Name of the device for which interface is configured. Use wwan0 for 4G/LTE. Required: YES.

string

>= 1 characters <= 64 characters

is_primary

object

monitor

object

monitor_disabled

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node of the site.

string

>= 1 characters <= 64 characters

not_primary

object

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

dedicated_management_interface

object

cluster

object

device

Device

Name of the device for which interface is configured Required: YES.

string

>= 1 characters <= 64 characters

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node of the site.

string

>= 1 characters <= 64 characters

description

Interface Description

Description for this Interface.

string

>= 21 characters <= 256 characters

ethernet_interface

object

cluster

object

device

Device

Interface configuration for the ethernet device Required: YES.

string

>= 1 characters <= 64 characters

dhcp_client

object

dhcp_server

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP Networks

List of networks from which DHCP Server can allocate IPv4 Addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCP Network

DHCP network configuration.

object

dgw_address

Configured Address

Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.

string

<= 1024 characters

dns_address

Configured Address

Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Network Prefix

Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IP Range

DHCP pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.

string

<= 1024 characters

start_ip

Start IP

Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.

string

<= 1024 characters

exclude

Exclude

X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.

boolean format: boolean

same_as_dgw

object

network_prefix_allocator

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

fixed_ip_map

Fixed IP Assignments

Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IP mapping

Specify static IPv4 addresses per site:node.

object

ipv6_auto_config

object

host

object

router

object

dns_config

object

configured_list

object

dns_list

Dns List

List of IPv6 Addresses acting as DNS servers Required: YES.

Array<string>

>= 1 items <= 4 items

local_dns

object

configured_address

Configured Address

Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Prefix Info

Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.

string

<= 1024 characters

stateful

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP IPV6 Networks

List of networks from which DHCP server can allocate IP addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCPIPV6NetworkType

DHCP IPv6 network type configuration.

object

network_prefix

Network Prefix

Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IPV6 Range

DHCP IPv6 pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.

string

<= 1024 characters

start_ip

Start IPV6

Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.

string

<= 1024 characters

fixed_ip_map

Fixed IPV6 Assignments

Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IPV6 mapping

Map of Site:Node to IPv6 address.

object

is_primary

object

monitor

object

monitor_disabled

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

no_ipv6_address

object

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node.

string

>= 1 characters <= 64 characters

not_primary

object

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

site_local_inside_network

object

site_local_network

object

static_ip

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

static_ipv6_address

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

storage_network

object

untagged

object

vlan_id

VLAN Id

Exclusive with [untagged] Configure a VLAN tagged ethernet interface.

integer format: int64

>= 1 <= 4094

labels

Interface labels

Add Labels for this Interface, these labels can be used in firewall policy.

object

tunnel_interface

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

node

Node

Exclusive with [] Configuration will apply to a given device on the given node.

string

>= 1 characters <= 64 characters

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

site_local_inside_network

object

site_local_network

object

static_ip

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

tunnel

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

no_forward_proxy

object

no_global_network

object

no_network_policy

object

outside_nameserver

outside_nameserver

Optional DNS server V4 IP to be used for name resolution in local network.

string

<= 1024 characters

outside_vip

Common V4 VIP

Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network.

string

<= 1024 characters

site_to_site_tunnel_ip

Site Mesh Group Connection Via Virtual Ip

string

<= 1024 characters

sli_config

object

no_static_routes

object

no_v6_static_routes

object

static_routes

object

static_routes

static_routes

List of static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

static_v6_routes

object

static_routes

static_routes

List of IPv6 static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static IPv6 Route

Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IPv6 Prefixes

List of IPv6 route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

slo_config

object

dc_cluster_group

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

labels

Network labels

Add Labels for this network, these labels can be used in firewall policy.

object

no_dc_cluster_group

object

no_static_routes

object

no_static_v6_routes

object

static_routes

object

static_routes

static_routes

List of static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

static_v6_routes

object

static_routes

static_routes

List of IPv6 static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static IPv6 Route

Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IPv6 Prefixes

List of IPv6 route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

sm_connection_public_ip

object

sm_connection_pvt_ip

object

tunnel_dead_timeout

tunnel_dead_timeout

Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.

integer format: int64

vip_vrrp_mode

string

default: VIP_VRRP_INVALID

Allowed values: VIP_VRRP_INVALID VIP_VRRP_ENABLE VIP_VRRP_DISABLE

custom_storage_config

object

default_storage_class

object

no_static_routes

object

no_storage_device

object

no_storage_interfaces

object

static_routes

object

static_routes

static_routes

List of static routes

Required: YES.

Array<object>

>= 1 items <= 16 items

Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object

attrs

Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

default_gateway

object

ip_address

IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string

<= 1024 characters

ip_prefixes

IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>

>= 1 items <= 256 items

node_interface

object

list

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>

<= 8 items

NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object

interface

Interface

Interface reference on this node.

Array<object>

<= 1 items

ObjectRefType

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

node

Node

Node name on this site.

string

<= 1024 characters

storage_class_list

object

storage_classes

List of Storage Classes

List of custom storage classes.

Array<object>

<= 4 items

Custom Storage Class

Configuration of custom storage class.

object

advanced_storage_parameters

Advanced Parameters

Map of parameter name and string value.

object

allow_volume_expansion

Allow Volume Expansion

Allow volume expansion.

boolean format: boolean

custom_storage

object

yaml

Storage Class YAML

K8s YAML for StorageClass.

string

<= 4096 characters

default_storage_class

Default Storage Class

Make this storage class default storage class for the K8s cluster.

boolean format: boolean

description

Storage Class Description

Description for this storage class.

string

>= 21 characters <= 256 characters

hpe_storage

object

allow_mutations

allowMutations

Mutation can override specified parameters.

string

<= 256 characters

allow_overrides

allowOverrides

PVC can override specified parameters.

string

<= 256 characters

dedupe_enabled

dedupeEnabled

Indicates that the volume should enable deduplication.

boolean format: boolean

description

Description

The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.

string

>= 21 characters <= 512 characters

destroy_on_delete

destroyOnDelete

Indicates the backing Nimble volume (including snapshots) should be destroyed when the PVC is deleted.

boolean format: boolean

encrypted

encrypted

Indicates that the volume should be encrypted.

boolean format: boolean

folder

folder

The name of the folder in which to place the volume.

string

<= 128 characters

limit_iops

limitIops

The IOPS limit of the volume.

string format: int64

<= 1024 characters

limit_mbps

limitMbps

The IOPS limit of the volume.

string format: int64

<= 1024 characters

performance_policy

performancePolicy

The name of the performance policy to assign to the volume.

string

<= 128 characters

pool

pool

The name of the pool in which to place the volume.

string

<= 128 characters

protection_template

protectionTemplate

The name of the performance policy to assign to the volume.

string

<= 128 characters

secret_name

Secret Name

The SecretName parameter is used to identify name of secret to identify backend storage’s auth information.

string

<= 256 characters

secret_namespace

Secret Namespace

The SecretNamespace parameter is used to identify name of namespace where secret resides.

string

<= 256 characters

sync_on_detach

syncOnDetach

Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node.

boolean format: boolean

thick

thick

Indicates that the volume should be thick provisioned.

boolean format: boolean

netapp_trident

object

selector

Selector

Using the Selector field, each StorageClass calls out which virtual pool(s) may be used to host a volume. The volume will have the aspects defined in the chosen virtual pool.

object

storage_pools

Storage Pools

The storagePools parameter is used to further restrict the set of pools that match any specified attributes.

string

<= 512 characters

pure_service_orchestrator

object

backend

Backend

Defines type of Pure storage backend block or file. The volume will have the aspects defined in the chosen virtual pool.

string

<= 1024 characters

bandwidth_limit

Bandwidth Limit

string

<= 12 characters

iops_limit

IOPS Limit

Enable IOPS limitation. It must be between 100 and 100 million. If value is 0, IOPS limit is not defined.

integer format: int64

reclaim_policy

Reclaim Policy

Reclaim Policy.

string

<= 16 characters

storage_class_name

Storage Class Name

Name of the storage class as it will appear in K8s. Required: YES.

string

<= 1024 characters

storage_device

Storage Device

Storage device that this class will use. The Device name defined at previous step. Required: YES.

string

>= 1 characters <= 64 characters

storage_device_list

object

storage_devices

List of Storage Devices

List of custom storage devices.

Array<object>

<= 4 items

Storage Device

Configuration of storage device.

object

advanced_advanced_parameters

Advanced Parameters

Map of parameter name and string value.

object

custom_storage

object

hpe_storage

object

api_server_port

Storage server Port

Enter Storage Server Port.

integer format: int64

iscsi_chap_password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

iscsi_chap_user

iscsi chapUser

Chap Username to connect to the HPE storage.

string

<= 256 characters

password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

storage_server_ip_address

Storage Server IP address

Enter storage server IP address.

string

<= 1024 characters

storage_server_name

Storage Server Name

Enter storage server Name.

string

<= 1024 characters

username

Username

Username to connect to the HPE storage management IP Required: YES.

string

>= 1 characters <= 256 characters

netapp_trident

object

netapp_backend_ontap_nas

object

auto_export_cidrs

object

prefixes

ipv4 prefix list

List of IPv4 prefixes that represent an endpoint.

Array<string>

<= 128 items

auto_export_policy

Auto Export Policy

Enable automatic export policy creation and updating.

boolean format: boolean

backend_name

Storage Backend Name

Configuration of Backend Name. Driver is name + ”_” + dataLIF.

string

>= 1 characters <= 50 characters

client_certificate

Client Certificate

Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.

string

<= 8192 characters

client_private_key

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

data_lif_dns_name

Backend Data LIF Name

Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

data_lif_ip

Backend Data LIF IP Address

Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

labels

Backend Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.

object

limit_aggregate_usage

Limit Aggregate Usage

Fail provisioning if usage is above this percentage. Not enforced by default.

string

<= 1024 characters

limit_volume_size

Limit Volume Size

Fail provisioning if requested volume size is above this value. Not enforced by default.

string

<= 1024 characters

management_lif_dns_name

Backend Management LIF Name

Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

management_lif_ip

Backend Management LIF IP Address

Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

nfs_mount_options

NFS Mount Options

Comma-separated list of NFS mount OPTIONS. Not enforced by default.

string

<= 1024 characters

password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

region

Backend Region

Virtual Pool Region.

string

<= 1024 characters

storage

Virtual Storage Pools

List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.

Array<object>

<= 8 items

Backend ONTAP Virtual Storage Pool

ONTAP Virtual Storage Pool definition.

object

labels

Storage Pool Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.

object

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

zone

Pool Zone

Virtual Storage Pool zone definition.

string

<= 1024 characters

storage_driver_name

Storage Backend Driver

Configuration of Backend Name Required: YES.

string

<= 1024 characters

storage_prefix

Storage Prefix

Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.

string

<= 1024 characters

svm

Backend SVM

Storage virtual machine to use. Derived if an SVM managementLIF is specified.

string

>= 1 characters <= 256 characters

trusted_ca_certificate

Trusted CA Certificate

Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..

string

<= 8192 characters

username

Username

Username to connect to the cluster/SVM Required: YES.

string

>= 1 characters <= 256 characters

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

netapp_backend_ontap_san

object

client_certificate

Client Certificate

Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.

string

<= 8192 characters

client_private_key

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

data_lif_dns_name

Backend Data LIF Name

Exclusive with [data_lif_ip] Backend Data LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

data_lif_ip

Backend Data LIF IP Address

Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

igroup_name

iGroup Name

Name of the igroup for SAN volumes to use.

string

>= 1 characters <= 256 characters

labels

Backend Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.

object

limit_aggregate_usage

Limit Aggregate Usage

Fail provisioning if usage is above this percentage. Not enforced by default.

integer format: int64

limit_volume_size

Limit Volume Size

Fail provisioning if requested volume size in GBi is above this value. Not enforced by default.

integer format: int32

management_lif_dns_name

Backend Management LIF Name

Exclusive with [management_lif_ip] Backend Management LIF IP Address’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

management_lif_ip

Backend Management LIF IP Address

Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.

string

<= 1024 characters

no_chap

object

password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

region

Backend Region

Virtual Pool Region.

string

<= 1024 characters

storage

Virtual Storage Pools

List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.

Array<object>

<= 8 items

Backend ONTAP Virtual Storage Pool

ONTAP Virtual Storage Pool definition.

object

labels

Storage Pool Labels

List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.

object

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

zone

Pool Zone

Virtual Storage Pool zone definition.

string

<= 1024 characters

storage_driver_name

Storage Backend Driver

Configuration of Backend Name Required: YES.

string

<= 1024 characters

storage_prefix

Storage Prefix

Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.

string

>= 1 characters <= 80 characters

svm

Backend SVM

Storage virtual machine to use. Derived if an SVM managementLIF is specified.

string

>= 1 characters <= 256 characters

trusted_ca_certificate

Trusted CA Certificate

Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..

string

<= 8192 characters

use_chap

object

chap_initiator_secret

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

chap_target_initiator_secret

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

chap_target_username

CHAP Target Username

Target username. Required if useCHAP=true.

string

>= 1 characters <= 256 characters

chap_username

CHAP Username

Inbound username. Required if useCHAP=true.

string

>= 1 characters <= 256 characters

username

Username

Username to connect to the cluster/SVM Required: YES.

string

>= 1 characters <= 256 characters

volume_defaults

object

adaptive_qos_policy

Storage Server IP address

Exclusive with [no_qos qos_policy] Enter Adaptive QoS Policy Name.

string

>= 1 characters <= 128 characters

encryption

Enable Encryption

Enable NetApp volume encryption.

boolean format: boolean

export_policy

Export Policy

Export policy to use.

string

<= 1024 characters

no_qos

object

qos_policy

QoS Policy Name

Exclusive with [adaptive_qos_policy no_qos] Enter QoS Policy Name.

string

>= 1 characters <= 128 characters

security_style

Security Style

Security style for new volumes.

string

<= 1024 characters

snapshot_dir

Access to Snapshot Directory

Access to the .snapshot directory.

boolean format: boolean

snapshot_policy

Snapshot Policy

Snapshot policy to use.

string

<= 1024 characters

snapshot_reserve

Snapshot Rerserved

Percentage of volume reserved for snapshots. “0” if snapshot policy is “none”, else ""

string

<= 1024 characters

space_reserve

Space Reservation Mode

Space reservation mode; “none” (thin) or “volume” (thick)

string

<= 1024 characters

split_on_clone

Split on Clone

Split a clone from its parent upon creation.

boolean format: boolean

tiering_policy

Tiering Policy

Tiering policy to use. “none” is default.

string

<= 1024 characters

unix_permissions

Unix Mode Permissions

Unix permission mode for new volumes. All allowed 777.

integer format: int32

pure_service_orchestrator

object

arrays

object

flash_array

object

default_fs_opt

Default Filesystem Options

Block volume default mkfs OPTIONS. Not recommended to change!

string

>= 1 characters <= 128 characters

default_fs_type

Default Filesystem Type

Block volume default filesystem type. Not recommended to change! Required: YES.

string

<= 1024 characters

default_mount_opts

Default Mount Options

Block volume default filesystem mount OPTIONS. Not recommended to change!

Array<string>

<= 4 items

disable_preempt_attachments

Disable Preempt Attachments

Enable/Disable attachment preemption!

boolean format: boolean

flash_arrays

Flash Arrays

For FlashArrays you must set the “mgmt_endpoint” and “api_token”

Required: YES.

Array<object>

>= 1 items <= 8 items

Flash Array Endpoint

For FlashArrays you must set the “mgmt_endpoint” and “api_token”

object

api_token

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

labels

Labels

The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.

object

mgmt_dns_name

dns_name

Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

mgmt_ip

Management Endpoint IP Address

Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.

string

<= 1024 characters

iscsi_login_timeout

iSCSI Login Timeout

ISCSI login timeout in seconds. Not recommended to change! Required: YES.

integer format: int32

san_type

SAN Type

Block volume access protocol, either ISCSI or FC Required: YES.

string

<= 1024 characters

flash_blade

object

enable_snapshot_directory

Enable Snapshot Directory

Enable/Disable FlashBlade snapshots.

boolean format: boolean

export_rules

NFS Export Rules

NFS Export rules.

string

>= 1 characters <= 250 characters

flash_blades

Flash Blades

For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint

Required: YES.

Array<object>

>= 1 items <= 8 items

Flash Blade Endpoint

For FlashBlades you must set the “mgmt_endpoint”, “api_token” and nfs_endpoint.

object

api_token

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

mgmt_dns_name

dns_name

Exclusive with [mgmt_ip] Management Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

mgmt_ip

Management Endpoint IP Address

Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.

string

<= 1024 characters

nfs_endpoint_dns_name

NFS DNS Name

Exclusive with [nfs_endpoint_ip] Endpoint’s IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.

string

<= 256 characters

nfs_endpoint_ip

NFS IP Address

Exclusive with [nfs_endpoint_dns_name] Endpoint is reachable at the given IP address.

string

<= 1024 characters

labels

Labels

The labels are optional, and can be any key-value pair for use with the PSO “fleet” provisioner.

object

cluster_id

Cluster ID

string

>= 1 characters <= 22 characters

enable_storage_topology

Enable Storage Topology

This option is to enable/disable the csi topology feature for pso-csi.

boolean format: boolean

enable_strict_topology

Enable Strict Topology

This option is to enable/disable the strict csi topology feature for pso-csi.

boolean format: boolean

storage_device

Storage Device

Storage device and device unit Required: YES.

string

<= 64 characters

storage_interface_list

object

storage_interfaces

List of Interfaces

Configure storage interfaces for this App Stack site

Required: YES.

Array<object>

>= 1 items <= 256 items

Storage Interfaces

Configure storage interface for this App Stack site.

object

description

Interface Description

Description for this Interface.

string

>= 21 characters <= 256 characters

labels

Interface labels

Add Labels for this Interface, these labels can be used in firewall policy.

object

storage_interface

object

cluster

object

device

Device

Interface configuration for the ethernet device Required: YES.

string

>= 1 characters <= 64 characters

dhcp_client

object

dhcp_server

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP Networks

List of networks from which DHCP Server can allocate IPv4 Addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCP Network

DHCP network configuration.

object

dgw_address

Configured Address

Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.

string

<= 1024 characters

dns_address

Configured Address

Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Network Prefix

Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IP Range

DHCP pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.

string

<= 1024 characters

start_ip

Start IP

Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.

string

<= 1024 characters

exclude

Exclude

X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.

boolean format: boolean

same_as_dgw

object

network_prefix_allocator

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

fixed_ip_map

Fixed IP Assignments

Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IP mapping

Specify static IPv4 addresses per site:node.

object

ipv6_auto_config

object

host

object

router

object

dns_config

object

configured_list

object

dns_list

Dns List

List of IPv6 Addresses acting as DNS servers Required: YES.

Array<string>

>= 1 items <= 4 items

local_dns

object

configured_address

Configured Address

Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.

string

<= 1024 characters

first_address

object

last_address

object

network_prefix

Prefix Info

Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.

string

<= 1024 characters

stateful

object

automatic_from_end

object

automatic_from_start

object

dhcp_networks

DHCP IPV6 Networks

List of networks from which DHCP server can allocate IP addresses

Required: YES.

Array<object>

>= 1 items <= 1 items

DHCPIPV6NetworkType

DHCP IPv6 network type configuration.

object

network_prefix

Network Prefix

Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.

string

<= 1024 characters

pool_settings

string

default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS

pools

DHCP pools

List of non overlapping IP address ranges.

Array<object>

<= 16 items

DHCP IPV6 Range

DHCP IPv6 pool is a range of IP addresses (start IP and end IP).

object

end_ip

End IP

Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.

string

<= 1024 characters

start_ip

Start IPV6

Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.

string

<= 1024 characters

fixed_ip_map

Fixed IPV6 Assignments

Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.

object

interface_ip_map

object

interface_ip_map

Site:Node to IPV6 mapping

Map of Site:Node to IPv6 address.

object

is_primary

object

monitor

object

monitor_disabled

object

mtu

Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64

no_ipv6_address

object

node

Node

Exclusive with [cluster] Configuration will apply to a device on the given node.

string

>= 1 characters <= 64 characters

not_primary

object

priority

Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64

site_local_inside_network

object

site_local_network

object

static_ip

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

static_ipv6_address

object

cluster_static_ip

object

interface_ip_map

Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object

node_static_ip

object

default_gw

Default Gateway

IP address of the default gateway.

string

<= 1024 characters

ip_address

Default Gateway

IP address of the interface and prefix length Required: YES.

string

<= 1024 characters

storage_network

object

untagged

object

vlan_id

VLAN Id

Exclusive with [untagged] Configure a VLAN tagged ethernet interface.

integer format: int64

>= 1 <= 4094

default_blocked_services

object

default_network_config

object

default_sriov_interface

object

default_storage_config

object

deny_all_usb

object

disable_gpu

object

disable_vm

object

enable_gpu

object

enable_vgpu

object

feature_type

string

default: UNLICENSED

Allowed values: UNLICENSED VGPU VWS VCS

server_address

License Server Address

Set License Server Address.

string

<= 1024 characters

server_port

License Server Port Number

Set License Server port number.

integer format: int64

enable_vm

object

k8s_cluster

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

kubernetes_upgrade_drain

object

disable_upgrade_drain

object

enable_upgrade_drain

object

disable_vega_upgrade_mode

object

drain_max_unavailable_node_count

Node Batch Size Count

Exclusive with []

integer format: int64

drain_node_timeout

Upgrade Wait Time

Required: YES.

integer format: int64

enable_vega_upgrade_mode

object

local_control_plane

object

bgp_config

object

asn

ASN

Autonomous System Number Required: YES.

integer format: int64

peers

BGP Peers

BGP parameters for peer.

Array<object>

<= 8 items

Peer

BGP Peer parameters.

object

bfd_disabled

object

bfd_enabled

object

multiplier

Multiplier

Specify Number of missed packets to bring session down” Required: YES.

integer format: int64

receive_interval_milliseconds

Receive Interval in milliseconds

BFD receive interval timer, in milliseconds Required: YES.

integer format: int64

transmit_interval_milliseconds

Transmit Interval in milliseconds

BFD transmit interval timer, in milliseconds Required: YES.

integer format: int64

disable

object

external

object

address

address

Exclusive with [default_gateway disable external_connector from_site subnet_begin_offset subnet_end_offset] Specify IPv4 peer address.

string

<= 1024 characters

address_ipv6

address_ipv6

Exclusive with [default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6 subnet_end_offset_v6] Specify peer IPv6 address.

string

<= 1024 characters

asn

ASN

Autonomous System Number for BGP peer Required: YES.

integer format: int64

default_gateway

object

default_gateway_v6

object

disable

object

disable_v6

object

external_connector

object

family_inet

object

disable

object

enable

object

from_site

object

from_site_v6

object

interface

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

interface_list

object

interfaces

interface_list

List of network interfaces.

Required: YES.

Array<object>

>= 1 items <= 16 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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

md5_auth_key

md5_auth_key

Exclusive with [no_authentication] MD5 key for protecting BGP Sessions (RFC 2385)

string

<= 1024 characters

no_authentication

object

port

Peer Port

Peer TCP port number.

integer format: int64

>= 1 <= 65535

subnet_begin_offset

subnet_begin_offset

Exclusive with [address default_gateway disable external_connector from_site subnet_end_offset] Calculate peer address using offset from the beginning of the subnet.

integer format: int64

subnet_begin_offset_v6

subnet_begin_offset_v6

Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_end_offset_v6] Calculate peer address using offset from the beginning of the subnet.

integer format: int64

subnet_end_offset

subnet_end_offset

Exclusive with [address default_gateway disable external_connector from_site subnet_begin_offset] Calculate peer address using offset from the end of the subnet.

integer format: int64

subnet_end_offset_v6

subnet_end_offset_v6

Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6] Calculate peer address using offset from the end of the subnet.

integer format: int64

label

label

Specify whether this peer should be.

string

<= 1024 characters

metadata

object

description

description

Human readable description.

string

>= 21 characters <= 256 characters

name

name

This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 1 characters <= 1024 characters

passive_mode_disabled

object

passive_mode_enabled

object

routing_policies

object

route_policy

route_policy

Route policy to be applied.

Array<object>

<= 4 items

BGP Route policy

List of filter rules which can be applied on all or particular nodes.

object

all_nodes

object

inbound

object

node_name

object

node

Node

Select BGP Session on which policy will be applied.

Array<string>

object_refs

Policy to apply

Select route policy to apply.

Required: YES.

Array<object>

>= 1 items <= 1 items

ObjectRefType

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

outbound

object

inside_vn

object

outside_vn

object

log_receiver

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

logs_streaming_disabled

object

master_node_configuration

Configuration of master nodes

Required: YES.

Array<object>

<= 3 items

Master Node

Master Node is the configuration of the master node.

object

name

Name

Names of master node Required: YES.

string

>= 6 characters <= 1024 characters

public_ip

Public IP

IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group.

string

<= 1024 characters

no_bond_devices

object

no_k8s_cluster

object

no_local_control_plane

object

offline_survivability_mode

object

enable_offline_survivability_mode

object

no_offline_survivability_mode

object

operating_system_version

Desired Operating System version that should be installed on the site.

string

<= 256 characters

site_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

sriov_interfaces

object

sriov_interface

Custom SR-IOV interfaces Configuration

Use custom SR-IOV interfaces Configuration.

Array<object>

SriovInterface specifies the configuration fo SR-IOV interfaces and how many virtual functions it has

Single Root I/O Virtualization interfaces configured explicitly By default no SR-IOV interface is assigned to the fleet.

object

interface_name

interface_name

Name of SR-IOV physical interface Required: YES.

string

<= 1024 characters

number_of_vfio_vfs

number_of_vfio_vfs

Number of virtual functions reserved for VNFs and DPDK-based CNFs.

integer format: int64

number_of_vfs

number_of_vfs

Total number of virtual functions Required: YES.

integer format: int64

usb_policy

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

volterra_certified_hw

Name for generic server certified hardware to form this App Stack site. Required: YES.

string

>= 1 characters <= 1024 characters

volterra_software_version

Desired F5 Distributed Cloud software version that should be installed on the site.

string

<= 256 characters

worker_nodes

Names of worker nodes.

Array<string>

<= 128 items

status

status

The status reported by different services for this configuration object.

Array<object>

>= 17 characters <= 17 characters

StatusObject

Most recently observed status of object.

object

conditions

conditions

Conditions represent the normalized status values for configuration object.

Array<object>

ConditionType

Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.

object

hostname

hostname

Hostname of the instance of the site that sent the status.

string

<= 1024 characters

last_update_time

last_update_time

Last time the condition was updated.

string format: date-time

<= 1024 characters

reason

reason

X-reason: “Insufficient memory in data plane” A human readable string explaining the reason for reaching this condition.

string

>= 27 characters <= 1024 characters

service_name

service name

Name of the service that sent the status.

string

<= 1024 characters

status

status

Status of the condition “Success” Validtion has succeded. Requested operation was successful. “Failed” Validation has failed. “Incomplete” Validation of configuration has failed due to missing configuration. “Installed” Validation has passed and configuration has been installed in data path or K8s “Down” Configuration is operationally down. E.g. Down interface “Disabled” Configuration is administratively disabled i.e. objectmetatype.disable = true. “NotApplicable” Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.

string

>= 17 characters <= 1024 characters

type

type

Type of the condition “Validation” represents validation user given configuration object “Operational” represents operational status of a given configuration object.

string

<= 1024 characters

metadata

object

creation_timestamp

creation_timestamp

Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.

string format: date-time

<= 1024 characters

creator_class

creator_class

Class of creator which created this StatusObject. This will be service’s DNS FQDN. This will be set by the system based on client certificate information.

string

<= 1024 characters

creator_id

creator_id

ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.

string

<= 1024 characters

publish

string

default: STATUS_DO_NOT_PUBLISH

Allowed values: STATUS_DO_NOT_PUBLISH STATUS_PUBLISH

status_id

status_id

Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID)

string

<= 1024 characters

uid

uid

Uid is the unique in time and space value for a StatusObject.

string format: uuid

>= 36 characters <= 1024 characters

vtrp_id

vtrp_id

Origin of this status exchanged by VTRP.

string

<= 1024 characters

vtrp_stale

vtrp_stale

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

boolean format: boolean

object_refs

object_refs

F5XC App Stack site object direct reference.

Array<object>

ObjectRefType

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

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

Example

{
  "create_form": {
    "spec": {
      "blocked_services": {
        "blocked_sevice": [
          {
            "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
          }
        ]
      },
      "custom_network_config": {
        "interface_list": {
          "interfaces": [
            {
              "ethernet_interface": {
                "dhcp_server": {
                  "dhcp_networks": [
                    {
                      "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                    }
                  ]
                },
                "ipv6_auto_config": {
                  "router": {
                    "stateful": {
                      "dhcp_networks": [
                        {
                          "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                        }
                      ]
                    }
                  }
                }
              }
            }
          ]
        },
        "sli_config": {
          "static_routes": {
            "static_routes": [
              {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ]
              }
            ]
          },
          "static_v6_routes": {
            "static_routes": [
              {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ]
              }
            ]
          }
        },
        "slo_config": {
          "static_routes": {
            "static_routes": [
              {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ]
              }
            ]
          },
          "static_v6_routes": {
            "static_routes": [
              {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ]
              }
            ]
          }
        },
        "vip_vrrp_mode": "VIP_VRRP_INVALID"
      },
      "custom_storage_config": {
        "static_routes": {
          "static_routes": [
            {
              "attrs": [
                "ROUTE_ATTR_NO_OP"
              ]
            }
          ]
        },
        "storage_device_list": {
          "storage_devices": [
            {
              "hpe_storage": {
                "iscsi_chap_password": {
                  "secret_encoding_type": "EncodingNone",
                  "vault_secret_info": {
                    "secret_encoding": "EncodingNone"
                  }
                },
                "password": {
                  "secret_encoding_type": "EncodingNone",
                  "vault_secret_info": {
                    "secret_encoding": "EncodingNone"
                  }
                }
              },
              "netapp_trident": {
                "netapp_backend_ontap_nas": {
                  "client_private_key": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  },
                  "password": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  }
                },
                "netapp_backend_ontap_san": {
                  "client_private_key": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  },
                  "password": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  },
                  "use_chap": {
                    "chap_initiator_secret": {
                      "secret_encoding_type": "EncodingNone",
                      "vault_secret_info": {
                        "secret_encoding": "EncodingNone"
                      }
                    },
                    "chap_target_initiator_secret": {
                      "secret_encoding_type": "EncodingNone",
                      "vault_secret_info": {
                        "secret_encoding": "EncodingNone"
                      }
                    }
                  }
                }
              },
              "pure_service_orchestrator": {
                "arrays": {
                  "flash_array": {
                    "flash_arrays": [
                      {
                        "api_token": {
                          "secret_encoding_type": "EncodingNone",
                          "vault_secret_info": {
                            "secret_encoding": "EncodingNone"
                          }
                        }
                      }
                    ]
                  },
                  "flash_blade": {
                    "flash_blades": [
                      {
                        "api_token": {
                          "secret_encoding_type": "EncodingNone",
                          "vault_secret_info": {
                            "secret_encoding": "EncodingNone"
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        },
        "storage_interface_list": {
          "storage_interfaces": [
            {
              "storage_interface": {
                "dhcp_server": {
                  "dhcp_networks": [
                    {
                      "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                    }
                  ]
                },
                "ipv6_auto_config": {
                  "router": {
                    "stateful": {
                      "dhcp_networks": [
                        {
                          "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                        }
                      ]
                    }
                  }
                }
              }
            }
          ]
        }
      },
      "enable_vgpu": {
        "feature_type": "UNLICENSED"
      }
    }
  },
  "replace_form": {
    "spec": {
      "blocked_services": {
        "blocked_sevice": [
          {
            "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
          }
        ]
      },
      "custom_network_config": {
        "interface_list": {
          "interfaces": [
            {
              "ethernet_interface": {
                "dhcp_server": {
                  "dhcp_networks": [
                    {
                      "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                    }
                  ]
                },
                "ipv6_auto_config": {
                  "router": {
                    "stateful": {
                      "dhcp_networks": [
                        {
                          "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                        }
                      ]
                    }
                  }
                }
              }
            }
          ]
        },
        "sli_config": {
          "static_routes": {
            "static_routes": [
              {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ]
              }
            ]
          },
          "static_v6_routes": {
            "static_routes": [
              {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ]
              }
            ]
          }
        },
        "slo_config": {
          "static_routes": {
            "static_routes": [
              {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ]
              }
            ]
          },
          "static_v6_routes": {
            "static_routes": [
              {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ]
              }
            ]
          }
        },
        "vip_vrrp_mode": "VIP_VRRP_INVALID"
      },
      "custom_storage_config": {
        "static_routes": {
          "static_routes": [
            {
              "attrs": [
                "ROUTE_ATTR_NO_OP"
              ]
            }
          ]
        },
        "storage_device_list": {
          "storage_devices": [
            {
              "hpe_storage": {
                "iscsi_chap_password": {
                  "secret_encoding_type": "EncodingNone",
                  "vault_secret_info": {
                    "secret_encoding": "EncodingNone"
                  }
                },
                "password": {
                  "secret_encoding_type": "EncodingNone",
                  "vault_secret_info": {
                    "secret_encoding": "EncodingNone"
                  }
                }
              },
              "netapp_trident": {
                "netapp_backend_ontap_nas": {
                  "client_private_key": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  },
                  "password": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  }
                },
                "netapp_backend_ontap_san": {
                  "client_private_key": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  },
                  "password": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  },
                  "use_chap": {
                    "chap_initiator_secret": {
                      "secret_encoding_type": "EncodingNone",
                      "vault_secret_info": {
                        "secret_encoding": "EncodingNone"
                      }
                    },
                    "chap_target_initiator_secret": {
                      "secret_encoding_type": "EncodingNone",
                      "vault_secret_info": {
                        "secret_encoding": "EncodingNone"
                      }
                    }
                  }
                }
              },
              "pure_service_orchestrator": {
                "arrays": {
                  "flash_array": {
                    "flash_arrays": [
                      {
                        "api_token": {
                          "secret_encoding_type": "EncodingNone",
                          "vault_secret_info": {
                            "secret_encoding": "EncodingNone"
                          }
                        }
                      }
                    ]
                  },
                  "flash_blade": {
                    "flash_blades": [
                      {
                        "api_token": {
                          "secret_encoding_type": "EncodingNone",
                          "vault_secret_info": {
                            "secret_encoding": "EncodingNone"
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        },
        "storage_interface_list": {
          "storage_interfaces": [
            {
              "storage_interface": {
                "dhcp_server": {
                  "dhcp_networks": [
                    {
                      "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                    }
                  ]
                },
                "ipv6_auto_config": {
                  "router": {
                    "stateful": {
                      "dhcp_networks": [
                        {
                          "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                        }
                      ]
                    }
                  }
                }
              }
            }
          ]
        }
      },
      "enable_vgpu": {
        "feature_type": "UNLICENSED"
      }
    }
  },
  "spec": {
    "blocked_services": {
      "blocked_sevice": [
        {
          "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
        }
      ]
    },
    "custom_network_config": {
      "interface_list": {
        "interfaces": [
          {
            "ethernet_interface": {
              "dhcp_server": {
                "dhcp_networks": [
                  {
                    "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                  }
                ]
              },
              "ipv6_auto_config": {
                "router": {
                  "stateful": {
                    "dhcp_networks": [
                      {
                        "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                      }
                    ]
                  }
                }
              }
            }
          }
        ]
      },
      "sli_config": {
        "static_routes": {
          "static_routes": [
            {
              "attrs": [
                "ROUTE_ATTR_NO_OP"
              ]
            }
          ]
        },
        "static_v6_routes": {
          "static_routes": [
            {
              "attrs": [
                "ROUTE_ATTR_NO_OP"
              ]
            }
          ]
        }
      },
      "slo_config": {
        "static_routes": {
          "static_routes": [
            {
              "attrs": [
                "ROUTE_ATTR_NO_OP"
              ]
            }
          ]
        },
        "static_v6_routes": {
          "static_routes": [
            {
              "attrs": [
                "ROUTE_ATTR_NO_OP"
              ]
            }
          ]
        }
      },
      "vip_vrrp_mode": "VIP_VRRP_INVALID"
    },
    "custom_storage_config": {
      "static_routes": {
        "static_routes": [
          {
            "attrs": [
              "ROUTE_ATTR_NO_OP"
            ]
          }
        ]
      },
      "storage_device_list": {
        "storage_devices": [
          {
            "hpe_storage": {
              "iscsi_chap_password": {
                "secret_encoding_type": "EncodingNone",
                "vault_secret_info": {
                  "secret_encoding": "EncodingNone"
                }
              },
              "password": {
                "secret_encoding_type": "EncodingNone",
                "vault_secret_info": {
                  "secret_encoding": "EncodingNone"
                }
              }
            },
            "netapp_trident": {
              "netapp_backend_ontap_nas": {
                "client_private_key": {
                  "secret_encoding_type": "EncodingNone",
                  "vault_secret_info": {
                    "secret_encoding": "EncodingNone"
                  }
                },
                "password": {
                  "secret_encoding_type": "EncodingNone",
                  "vault_secret_info": {
                    "secret_encoding": "EncodingNone"
                  }
                }
              },
              "netapp_backend_ontap_san": {
                "client_private_key": {
                  "secret_encoding_type": "EncodingNone",
                  "vault_secret_info": {
                    "secret_encoding": "EncodingNone"
                  }
                },
                "password": {
                  "secret_encoding_type": "EncodingNone",
                  "vault_secret_info": {
                    "secret_encoding": "EncodingNone"
                  }
                },
                "use_chap": {
                  "chap_initiator_secret": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  },
                  "chap_target_initiator_secret": {
                    "secret_encoding_type": "EncodingNone",
                    "vault_secret_info": {
                      "secret_encoding": "EncodingNone"
                    }
                  }
                }
              }
            },
            "pure_service_orchestrator": {
              "arrays": {
                "flash_array": {
                  "flash_arrays": [
                    {
                      "api_token": {
                        "secret_encoding_type": "EncodingNone",
                        "vault_secret_info": {
                          "secret_encoding": "EncodingNone"
                        }
                      }
                    }
                  ]
                },
                "flash_blade": {
                  "flash_blades": [
                    {
                      "api_token": {
                        "secret_encoding_type": "EncodingNone",
                        "vault_secret_info": {
                          "secret_encoding": "EncodingNone"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      },
      "storage_interface_list": {
        "storage_interfaces": [
          {
            "storage_interface": {
              "dhcp_server": {
                "dhcp_networks": [
                  {
                    "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                  }
                ]
              },
              "ipv6_auto_config": {
                "router": {
                  "stateful": {
                    "dhcp_networks": [
                      {
                        "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"
                      }
                    ]
                  }
                }
              }
            }
          }
        ]
      }
    },
    "enable_vgpu": {
      "feature_type": "UNLICENSED"
    },
    "site_state": "ONLINE"
  },
  "status": [
    {
      "metadata": {
        "publish": "STATUS_DO_NOT_PUBLISH"
      }
    }
  ]
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

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

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

GET App Stack site.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated