Replace Fleet.

PUT

/api/config/namespaces/{metadata.namespace}/fleets/{metadata.name}

curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/fleets/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "metadata": { "annotations": {}, "description": "example", "disable": true, "labels": {}, "name": "example", "namespace": "example" }, "spec": { "allow_all_usb": {}, "blocked_services": [ { "dns": {}, "network_type": "VIRTUAL_NETWORK_SITE_LOCAL", "ssh": {}, "web_user_interface": {} } ], "bond_device_list": { "bond_devices": [ { "active_backup": {}, "devices": [ "example" ], "lacp": { "rate": 1 }, "link_polling_interval": 1, "link_up_delay": 1, "name": "example" } ] }, "dc_cluster_group": { "name": "example", "namespace": "example" }, "dc_cluster_group_inside": { "name": "example", "namespace": "example" }, "default_config": {}, "default_sriov_interface": {}, "default_storage_class": {}, "deny_all_usb": {}, "device_list": { "devices": [ { "name": "example", "network_device": { "interface": [ { "name": "example", "namespace": "example" } ], "use": "NETWORK_INTERFACE_USE_REGULAR" }, "owner": "DEVICE_OWNER_INVALID" } ] }, "disable_gpu": {}, "disable_vm": {}, "enable_default_fleet_config_download": true, "enable_gpu": {}, "enable_vgpu": { "feature_type": "UNLICENSED", "server_address": "example", "server_port": 1 }, "enable_vm": {}, "inside_virtual_network": [ { "name": "example", "namespace": "example" } ], "interface_list": { "interfaces": [ { "name": "example", "namespace": "example" } ] }, "kubernetes_upgrade_drain": { "disable_upgrade_drain": {}, "enable_upgrade_drain": { "disable_vega_upgrade_mode": {}, "drain_max_unavailable_node_count": 1, "drain_node_timeout": 1, "enable_vega_upgrade_mode": {} } }, "log_receiver": { "name": "example", "namespace": "example" }, "logs_streaming_disabled": {}, "network_connectors": [ { "name": "example", "namespace": "example" } ], "network_firewall": [ { "name": "example", "namespace": "example" } ], "no_bond_devices": {}, "no_dc_cluster_group": {}, "no_storage_device": {}, "no_storage_interfaces": {}, "no_storage_static_routes": {}, "operating_system_version": "example", "outside_virtual_network": [ { "name": "example", "namespace": "example" } ], "performance_enhancement_mode": { "perf_mode_l3_enhanced": { "jumbo": {}, "no_jumbo": {} }, "perf_mode_l7_enhanced": {} }, "sriov_interfaces": { "sriov_interface": [ { "interface_name": "example", "number_of_vfio_vfs": 1, "number_of_vfs": 1 } ] }, "storage_class_list": { "storage_classes": [ { "advanced_storage_parameters": {}, "allow_volume_expansion": true, "custom_storage": { "yaml": "example" }, "default_storage_class": true, "description": "example", "hpe_storage": { "allow_mutations": "example", "allow_overrides": "example", "dedupe_enabled": true, "description": "example", "destroy_on_delete": true, "encrypted": true, "folder": "example", "limit_iops": "example", "limit_mbps": "example", "performance_policy": "example", "pool": "example", "protection_template": "example", "secret_name": "example", "secret_namespace": "example", "sync_on_detach": true, "thick": true }, "netapp_trident": { "selector": {}, "storage_pools": "example" }, "pure_service_orchestrator": { "backend": "example", "bandwidth_limit": "example", "iops_limit": 1 }, "reclaim_policy": "example", "storage_class_name": "example", "storage_device": "example" } ] }, "storage_device_list": { "storage_devices": [ { "advanced_advanced_parameters": {}, "custom_storage": {}, "hpe_storage": { "api_server_port": 1, "iscsi_chap_password": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "iscsi_chap_user": "example", "password": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "storage_server_ip_address": "example", "storage_server_name": "example", "username": "example" }, "netapp_trident": { "netapp_backend_ontap_nas": { "auto_export_cidrs": { "prefixes": [ "example" ] }, "auto_export_policy": true, "backend_name": "example", "client_certificate": "example", "client_private_key": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "data_lif_dns_name": "example", "data_lif_ip": "example", "labels": {}, "limit_aggregate_usage": "example", "limit_volume_size": "example", "management_lif_dns_name": "example", "management_lif_ip": "example", "nfs_mount_options": "example", "password": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "region": "example", "storage": [ { "labels": {}, "volume_defaults": { "adaptive_qos_policy": "example", "encryption": true, "export_policy": "example", "no_qos": {}, "qos_policy": "example", "security_style": "example", "snapshot_dir": true, "snapshot_policy": "example", "snapshot_reserve": "example", "space_reserve": "example", "split_on_clone": true, "tiering_policy": "example", "unix_permissions": 1 }, "zone": "example" } ], "storage_driver_name": "example", "storage_prefix": "example", "svm": "example", "trusted_ca_certificate": "example", "username": "example", "volume_defaults": { "adaptive_qos_policy": "example", "encryption": true, "export_policy": "example", "no_qos": {}, "qos_policy": "example", "security_style": "example", "snapshot_dir": true, "snapshot_policy": "example", "snapshot_reserve": "example", "space_reserve": "example", "split_on_clone": true, "tiering_policy": "example", "unix_permissions": 1 } }, "netapp_backend_ontap_san": { "client_certificate": "example", "client_private_key": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "data_lif_dns_name": "example", "data_lif_ip": "example", "igroup_name": "example", "labels": {}, "limit_aggregate_usage": 1, "limit_volume_size": 1, "management_lif_dns_name": "example", "management_lif_ip": "example", "no_chap": {}, "password": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "region": "example", "storage": [ { "labels": {}, "volume_defaults": { "adaptive_qos_policy": "example", "encryption": true, "export_policy": "example", "no_qos": {}, "qos_policy": "example", "security_style": "example", "snapshot_dir": true, "snapshot_policy": "example", "snapshot_reserve": "example", "space_reserve": "example", "split_on_clone": true, "tiering_policy": "example", "unix_permissions": 1 }, "zone": "example" } ], "storage_driver_name": "example", "storage_prefix": "example", "svm": "example", "trusted_ca_certificate": "example", "use_chap": { "chap_initiator_secret": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "chap_target_initiator_secret": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "chap_target_username": "example", "chap_username": "example" }, "username": "example", "volume_defaults": { "adaptive_qos_policy": "example", "encryption": true, "export_policy": "example", "no_qos": {}, "qos_policy": "example", "security_style": "example", "snapshot_dir": true, "snapshot_policy": "example", "snapshot_reserve": "example", "space_reserve": "example", "split_on_clone": true, "tiering_policy": "example", "unix_permissions": 1 } } }, "pure_service_orchestrator": { "arrays": { "flash_array": { "default_fs_opt": "example", "default_fs_type": "example", "default_mount_opts": [ "example" ], "disable_preempt_attachments": true, "flash_arrays": [ { "api_token": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "labels": {}, "mgmt_dns_name": "example", "mgmt_ip": "example" } ], "iscsi_login_timeout": 1, "san_type": "example" }, "flash_blade": { "enable_snapshot_directory": true, "export_rules": "example", "flash_blades": [ { "api_token": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" } }, "mgmt_dns_name": "example", "mgmt_ip": "example", "nfs_endpoint_dns_name": "example", "nfs_endpoint_ip": "example", "labels": {} } ] } }, "cluster_id": "example", "enable_storage_topology": true, "enable_strict_topology": true }, "storage_device": "example" } ] }, "storage_interface_list": { "interfaces": [ { "name": "example", "namespace": "example" } ] }, "storage_static_routes": { "storage_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] } ] }, "usb_policy": { "name": "example", "namespace": "example" }, "volterra_software_version": "example" } }'

• F5 Distributed Cloud Console

Replace fleet will replace the contents of given fleet object.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

metadata.namespace

required

string

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

metadata.name

required

string

Name The configuration object to be replaced will be looked up by name.

Request Body^required

Media typeapplication/json

ReplaceRequest is used to replace contents of a fleet

This is the input message of the ‘Replace’ RPC.

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

allow_all_usb

object

blocked_services

Disable node local services on this site.

Array<object>

<= 6 items

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

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

dc_cluster_group_inside

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

default_config

object

default_sriov_interface

object

default_storage_class

object

deny_all_usb

object

device_list

object

devices

Add device for all interfaces belonging to this fleet

Configuration for all devices in the fleet. Examples of devices are - network interfaces, cameras, scanners etc. Configuration a device is applied on VER node if the VER node is member of this fleet and has an corresponding interface/device. The mapping from device configured in fleet with interface/device in VER node depends on the type of device and is documented in device instance specific sections.

Array<object>

<= 8 items

Device Instance

Device Instance describes a single device in fleet A device can be of type network interface, camera, scanner etc. A device instance is created for each instance of device. If there are 2 network interfaces(eth0, eth1…), then 2 DeviceInstanceType are created one for eth0 and another for eth1.

object

name

Name

Name of the device including the unit number (e.g. Eth0 or disk1). The name must match name of device in host-OS of node.

string

>= 6 characters <= 1024 characters

network_device

object

interface

Network Interface

Network Interface attributes for the device. User network interface configuration for this network device. Attributes like labels, MTU from the ‘interface’ are applied to corresponding interface in VER node If network interface refers to a virtual-network, the virtual-netowrk type must be consistent with use attribute given below If use is NETWORK_INTERFACE_USE_REGULAR, the virtual-network must be of type VIRTUAL_NETWORK_SITE_LOCAL or VIRTUAL_NETWORK_SITE_LOCAL_INSIDE if use is NETWORK_INTERFACE_USE_OUTSIDE, the virtual-network must of type VIRTUAL_NETWORK_SITE_LOCAL if use is NETWORK_INTERFACE_USE_INSIDE, the virtual-network must of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE

Required: YES.

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

use

string

default: NETWORK_INTERFACE_USE_REGULAR

Allowed values: NETWORK_INTERFACE_USE_REGULAR NETWORK_INTERFACE_USE_OUTSIDE NETWORK_INTERFACE_USE_INSIDE

owner

string

default: DEVICE_OWNER_INVALID

Allowed values: DEVICE_OWNER_INVALID DEVICE_OWNER_VER DEVICE_OWNER_VK8S_WORK_LOAD DEVICE_OWNER_HOST

disable_gpu

object

disable_vm

object

enable_default_fleet_config_download

Enable default fleet config, It must be set for storage config and GPU config.

boolean format: boolean

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

inside_virtual_network

Default inside (site local) virtual network for the fleet.

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

interface_list

object

interfaces

List of Interfaces

Add all interfaces belonging to this fleet

Required: YES.

Array<object>

>= 1 items <= 256 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

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

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

network_connectors

Network Connector defines connection between two virtual networks in a given site. Fleet defines one or more such network connectors. The network connectors configuration is applied on all sites that are member of the fleet.

Array<object>

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

network_firewall

Network Firewall defines firewall to be applied for the virtual networks in the fleet. The network firewall configuration is applied on all sites that are member of the fleet.

Constraints The Network Firewall is applied on Virtual Networks of type site local network and site local inside network.

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

no_bond_devices

object

no_dc_cluster_group

object

no_storage_device

object

no_storage_interfaces

object

no_storage_static_routes

object

operating_system_version

Desired Operating System version that is applied to all sites that are member of the fleet. Current Operating System version can be overridden via site config.

string

<= 256 characters

outside_virtual_network

Default outside (site local) virtual network for the fleet.

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

performance_enhancement_mode

object

perf_mode_l3_enhanced

object

jumbo

object

no_jumbo

object

perf_mode_l7_enhanced

object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

interfaces

List of Interfaces

Add all interfaces belonging to this fleet

Required: YES.

Array<object>

>= 1 items <= 256 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

storage_static_routes

object

storage_routes

List of Static Routes

List of storage static routes

Required: YES.

Array<object>

>= 1 items <= 8 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 route attributes associated with the static route.

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

labels

Static Route labels

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

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-Interface”

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

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

object

plen

Prefix Length

Prefix-length of the IPv4 subnet. Must be <= 32.

integer format: int64

prefix

Prefix

Prefix part of the IPv4 subnet in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”

string

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

F5XC software version is human readable string matching released set of version components. The given software version is applied to all sites that are member of the fleet. Current software installed can be overridden via site config.

string

<= 256 characters

Responses

200

A successful response.

Media typeapplication/json

object

Example^generated

{}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

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

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example