@robinmordasiewicz/f5xc-terraform-mcp 2.4.6 → 2.4.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/resources/addon_subscription.md +5 -5
- package/dist/docs/resources/address_allocator.md +3 -3
- package/dist/docs/resources/advertise_policy.md +39 -39
- package/dist/docs/resources/alert_policy.md +6 -6
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +9 -9
- package/dist/docs/resources/api_testing.md +40 -40
- package/dist/docs/resources/apm.md +320 -320
- package/dist/docs/resources/app_api_group.md +10 -10
- package/dist/docs/resources/app_firewall.md +36 -36
- package/dist/docs/resources/app_setting.md +46 -46
- package/dist/docs/resources/app_type.md +3 -3
- package/dist/docs/resources/authentication.md +30 -30
- package/dist/docs/resources/aws_tgw_site.md +184 -184
- package/dist/docs/resources/aws_vpc_site.md +296 -296
- package/dist/docs/resources/azure_vnet_site.md +677 -677
- package/dist/docs/resources/bgp.md +20 -20
- package/dist/docs/resources/bgp_routing_policy.md +4 -4
- package/dist/docs/resources/cdn_cache_rule.md +68 -68
- package/dist/docs/resources/cdn_loadbalancer.md +1166 -1166
- package/dist/docs/resources/certificate.md +4 -4
- package/dist/docs/resources/child_tenant.md +2 -2
- package/dist/docs/resources/cloud_connect.md +33 -33
- package/dist/docs/resources/cloud_credentials.md +37 -37
- package/dist/docs/resources/cloud_link.md +16 -16
- package/dist/docs/resources/cluster.md +68 -68
- package/dist/docs/resources/cminstance.md +6 -6
- package/dist/docs/resources/code_base_integration.md +82 -82
- package/dist/docs/resources/container_registry.md +2 -2
- package/dist/docs/resources/data_type.md +12 -12
- package/dist/docs/resources/discovery.md +71 -71
- package/dist/docs/resources/dns_lb_health_check.md +5 -5
- package/dist/docs/resources/dns_load_balancer.md +25 -25
- package/dist/docs/resources/dns_zone.md +144 -144
- package/dist/docs/resources/endpoint.md +1 -1
- package/dist/docs/resources/enhanced_firewall_policy.md +33 -33
- package/dist/docs/resources/external_connector.md +32 -32
- package/dist/docs/resources/fast_acl.md +59 -59
- package/dist/docs/resources/fast_acl_rule.md +2 -2
- package/dist/docs/resources/filter_set.md +3 -3
- package/dist/docs/resources/fleet.md +359 -359
- package/dist/docs/resources/forward_proxy_policy.md +18 -18
- package/dist/docs/resources/gcp_vpc_site.md +280 -280
- package/dist/docs/resources/geo_location_set.md +1 -1
- package/dist/docs/resources/global_log_receiver.md +216 -216
- package/dist/docs/resources/healthcheck.md +2 -2
- package/dist/docs/resources/http_loadbalancer.md +2190 -2190
- package/dist/docs/resources/infraprotect_tunnel.md +9 -9
- package/dist/docs/resources/k8s_cluster.md +39 -39
- package/dist/docs/resources/k8s_cluster_role.md +10 -10
- package/dist/docs/resources/k8s_pod_security_policy.md +9 -9
- package/dist/docs/resources/log_receiver.md +11 -11
- package/dist/docs/resources/malicious_user_mitigation.md +4 -4
- package/dist/docs/resources/managed_tenant.md +2 -2
- package/dist/docs/resources/nat_policy.md +22 -22
- package/dist/docs/resources/network_connector.md +37 -37
- package/dist/docs/resources/network_firewall.md +15 -15
- package/dist/docs/resources/network_interface.md +78 -78
- package/dist/docs/resources/network_policy.md +21 -21
- package/dist/docs/resources/network_policy_view.md +7 -7
- package/dist/docs/resources/nfv_service.md +306 -306
- package/dist/docs/resources/oidc_provider.md +1 -1
- package/dist/docs/resources/origin_pool.md +151 -151
- package/dist/docs/resources/policy_based_routing.md +71 -71
- package/dist/docs/resources/protocol_inspection.md +8 -8
- package/dist/docs/resources/proxy.md +401 -401
- package/dist/docs/resources/rate_limiter_policy.md +4 -4
- package/dist/docs/resources/registration.md +1 -1
- package/dist/docs/resources/route.md +155 -155
- package/dist/docs/resources/secret_management_access.md +103 -103
- package/dist/docs/resources/secret_policy.md +7 -7
- package/dist/docs/resources/securemesh_site.md +274 -274
- package/dist/docs/resources/securemesh_site_v2.md +940 -940
- package/dist/docs/resources/sensitive_data_policy.md +3 -3
- package/dist/docs/resources/service_policy.md +154 -154
- package/dist/docs/resources/service_policy_rule.md +51 -51
- package/dist/docs/resources/subnet.md +7 -7
- package/dist/docs/resources/tcp_loadbalancer.md +138 -138
- package/dist/docs/resources/tenant_configuration.md +1 -1
- package/dist/docs/resources/ticket_tracking_system.md +2 -2
- package/dist/docs/resources/tunnel.md +16 -16
- package/dist/docs/resources/udp_loadbalancer.md +56 -56
- package/dist/docs/resources/virtual_host.md +146 -146
- package/dist/docs/resources/virtual_network.md +7 -7
- package/dist/docs/resources/voltshare_admin_policy.md +22 -22
- package/dist/docs/resources/voltstack_site.md +778 -778
- package/dist/docs/resources/waf_exclusion_policy.md +22 -22
- package/dist/docs/resources/workload.md +2226 -2226
- package/package.json +1 -1
|
@@ -173,11 +173,11 @@ A [`blocked_sevice`](#blocked-services-blocked-sevice) block (within [`blocked_s
|
|
|
173
173
|
|
|
174
174
|
<a id="blocked-services-blocked-sevice-dns"></a>• [`dns`](#blocked-services-blocked-sevice-dns) - Optional Block<br>Enable this option
|
|
175
175
|
|
|
176
|
-
<a id="
|
|
176
|
+
<a id="type-808ec9"></a>• [`network_type`](#type-808ec9) - Optional String Defaults to `VIRTUAL_NETWORK_SITE_LOCAL`<br>Possible values are `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`<br>[Enum: 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 Type. Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created automatically and present on all sites Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site. It is a secure network and is not connected to public network. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created during provisioning of site User defined per-site virtual network. Scope of this virtual network is limited to the site. This is not yet supported Virtual-network of type VIRTUAL_NETWORK_PUBLIC directly conects to the public internet. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on RE sites only It is an internally created by the system. They must not be created by user Virtual Neworks with global scope across different sites in F5XC domain. An example global virtual-network called 'AIN Network' is created for every tenant. for volterra fabric Constraints: It is currently only supported as internally created by the system. vK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant Constraints: It is an internally created by the system. Must not be created by user VER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy Constraints: It is an internally created by the system. Must not be created by user Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both VIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE Constraints: This network type is only meaningful in an advertise policy When virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for an endpoint, VER will try to determine the network based on the provided IP address Constraints: This network type is only meaningful in an endpoint VoltADN Private Network is used on volterra RE(s) to connect to customer private networks This network is created by opening a support ticket This network is per site srv6 network VER IP Fabric network for the site. This Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or for endpoint in IP Fabric network Constraints: It is an internally created by the system. Must not be created by user Network internally created for a segment Constraints: It is an internally created by the system. Must not be created by user
|
|
177
177
|
|
|
178
178
|
<a id="blocked-services-blocked-sevice-ssh"></a>• [`ssh`](#blocked-services-blocked-sevice-ssh) - Optional Block<br>Enable this option
|
|
179
179
|
|
|
180
|
-
<a id="
|
|
180
|
+
<a id="interface-e57e21"></a>• [`web_user_interface`](#interface-e57e21) - Optional Block<br>Enable this option
|
|
181
181
|
|
|
182
182
|
#### Bond Device List
|
|
183
183
|
|
|
@@ -189,15 +189,15 @@ A [`bond_device_list`](#bond-device-list) block supports the following:
|
|
|
189
189
|
|
|
190
190
|
A [`bond_devices`](#bond-device-list-bond-devices) block (within [`bond_device_list`](#bond-device-list)) supports the following:
|
|
191
191
|
|
|
192
|
-
<a id="
|
|
192
|
+
<a id="backup-c22794"></a>• [`active_backup`](#backup-c22794) - Optional Block<br>Enable this option
|
|
193
193
|
|
|
194
194
|
<a id="bond-device-list-bond-devices-devices"></a>• [`devices`](#bond-device-list-bond-devices-devices) - Optional List<br>Member Ethernet Devices. Ethernet devices that will make up this bond
|
|
195
195
|
|
|
196
196
|
<a id="bond-device-list-bond-devices-lacp"></a>• [`lacp`](#bond-device-list-bond-devices-lacp) - Optional Block<br>LACP parameters. LACP parameters for the bond device<br>See [Lacp](#bond-device-list-bond-devices-lacp) below.
|
|
197
197
|
|
|
198
|
-
<a id="
|
|
198
|
+
<a id="interval-0b4c96"></a>• [`link_polling_interval`](#interval-0b4c96) - Optional Number<br>Link Polling Interval. Link polling interval in milliseconds
|
|
199
199
|
|
|
200
|
-
<a id="
|
|
200
|
+
<a id="delay-b1200b"></a>• [`link_up_delay`](#delay-b1200b) - Optional Number<br>Link Up Delay. Milliseconds wait before link is declared up
|
|
201
201
|
|
|
202
202
|
<a id="bond-device-list-bond-devices-name"></a>• [`name`](#bond-device-list-bond-devices-name) - Optional String<br>Bond Device Name. Name for the Bond. Ex 'bond0'
|
|
203
203
|
|
|
@@ -227,11 +227,11 @@ A [`custom_dns`](#custom-dns) block supports the following:
|
|
|
227
227
|
|
|
228
228
|
A [`custom_network_config`](#custom-network-config) block supports the following:
|
|
229
229
|
|
|
230
|
-
<a id="
|
|
230
|
+
<a id="policies-c4c984"></a>• [`active_enhanced_firewall_policies`](#policies-c4c984) - Optional Block<br>Active Enhanced Network Policies Type. List of Enhanced Firewall Policies These policies use session-based rules and provide all options available under firewall policies with an additional option for service insertion<br>See [Active Enhanced Firewall Policies](#policies-c4c984) below.
|
|
231
231
|
|
|
232
|
-
<a id="
|
|
232
|
+
<a id="policies-fbbf75"></a>• [`active_forward_proxy_policies`](#policies-fbbf75) - Optional Block<br>Active Forward Proxy Policies Type. Ordered List of Forward Proxy Policies active<br>See [Active Forward Proxy Policies](#policies-fbbf75) below.
|
|
233
233
|
|
|
234
|
-
<a id="
|
|
234
|
+
<a id="policies-e8cb6b"></a>• [`active_network_policies`](#policies-e8cb6b) - Optional Block<br>Active Firewall Policies Type. List of firewall policy views<br>See [Active Network Policies](#policies-e8cb6b) below.
|
|
235
235
|
|
|
236
236
|
<a id="custom-network-config-bgp-peer-address"></a>• [`bgp_peer_address`](#custom-network-config-bgp-peer-address) - Optional String<br>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
|
|
237
237
|
|
|
@@ -239,13 +239,13 @@ A [`custom_network_config`](#custom-network-config) block supports the following
|
|
|
239
239
|
|
|
240
240
|
<a id="custom-network-config-default-config"></a>• [`default_config`](#custom-network-config-default-config) - Optional Block<br>Enable this option
|
|
241
241
|
|
|
242
|
-
<a id="
|
|
242
|
+
<a id="config-226341"></a>• [`default_interface_config`](#config-226341) - Optional Block<br>Enable this option
|
|
243
243
|
|
|
244
|
-
<a id="
|
|
244
|
+
<a id="config-ac20e7"></a>• [`default_sli_config`](#config-ac20e7) - Optional Block<br>Enable this option
|
|
245
245
|
|
|
246
|
-
<a id="
|
|
246
|
+
<a id="all-1d28e8"></a>• [`forward_proxy_allow_all`](#all-1d28e8) - Optional Block<br>Enable this option
|
|
247
247
|
|
|
248
|
-
<a id="
|
|
248
|
+
<a id="list-452116"></a>• [`global_network_list`](#list-452116) - Optional Block<br>Global Network Connection List. List of global network connections<br>See [Global Network List](#list-452116) below.
|
|
249
249
|
|
|
250
250
|
<a id="custom-network-config-interface-list"></a>• [`interface_list`](#custom-network-config-interface-list) - Optional Block<br>List of Interface. Configure network interfaces for this App Stack site<br>See [Interface List](#custom-network-config-interface-list) below.
|
|
251
251
|
|
|
@@ -255,1703 +255,1703 @@ A [`custom_network_config`](#custom-network-config) block supports the following
|
|
|
255
255
|
|
|
256
256
|
<a id="custom-network-config-no-network-policy"></a>• [`no_network_policy`](#custom-network-config-no-network-policy) - Optional Block<br>Enable this option
|
|
257
257
|
|
|
258
|
-
<a id="
|
|
258
|
+
<a id="nameserver-8c35de"></a>• [`outside_nameserver`](#nameserver-8c35de) - Optional String<br>DNS V4 Server for Local Network. Optional DNS server V4 IP to be used for name resolution in local network
|
|
259
259
|
|
|
260
260
|
<a id="custom-network-config-outside-vip"></a>• [`outside_vip`](#custom-network-config-outside-vip) - Optional String<br>Common V4 VIP. Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network
|
|
261
261
|
|
|
262
|
-
<a id="
|
|
262
|
+
<a id="tunnel-ip-7f6123"></a>• [`site_to_site_tunnel_ip`](#tunnel-ip-7f6123) - Optional String<br>Site Mesh Group Connection Via Virtual 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
|
|
263
263
|
|
|
264
264
|
<a id="custom-network-config-sli-config"></a>• [`sli_config`](#custom-network-config-sli-config) - Optional Block<br>Site Local Inside Network Configuration. Site local inside network configuration<br>See [SLI Config](#custom-network-config-sli-config) below.
|
|
265
265
|
|
|
266
266
|
<a id="custom-network-config-slo-config"></a>• [`slo_config`](#custom-network-config-slo-config) - Optional Block<br>Site Local Network Configuration. Site local network configuration<br>See [Slo Config](#custom-network-config-slo-config) below.
|
|
267
267
|
|
|
268
|
-
<a id="
|
|
268
|
+
<a id="public-ip-5fd49f"></a>• [`sm_connection_public_ip`](#public-ip-5fd49f) - Optional Block<br>Enable this option
|
|
269
269
|
|
|
270
|
-
<a id="
|
|
270
|
+
<a id="pvt-ip-892ce0"></a>• [`sm_connection_pvt_ip`](#pvt-ip-892ce0) - Optional Block<br>Enable this option
|
|
271
271
|
|
|
272
|
-
<a id="
|
|
272
|
+
<a id="timeout-1607a1"></a>• [`tunnel_dead_timeout`](#timeout-1607a1) - Optional Number<br>Tunnel Dead Timeout (msec). 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
|
|
273
273
|
|
|
274
274
|
<a id="custom-network-config-vip-vrrp-mode"></a>• [`vip_vrrp_mode`](#custom-network-config-vip-vrrp-mode) - Optional String Defaults to `VIP_VRRP_INVALID`<br>Possible values are `VIP_VRRP_INVALID`, `VIP_VRRP_ENABLE`, `VIP_VRRP_DISABLE`<br>[Enum: VIP_VRRP_INVALID|VIP_VRRP_ENABLE|VIP_VRRP_DISABLE] VRRP Virtual-IP. VRRP advertisement mode for VIP Invalid VRRP mode
|
|
275
275
|
|
|
276
276
|
#### Custom Network Config Active Enhanced Firewall Policies
|
|
277
277
|
|
|
278
|
-
An [`active_enhanced_firewall_policies`](#
|
|
278
|
+
An [`active_enhanced_firewall_policies`](#policies-c4c984) block (within [`custom_network_config`](#custom-network-config)) supports the following:
|
|
279
279
|
|
|
280
|
-
<a id="
|
|
280
|
+
<a id="policies-d28848"></a>• [`enhanced_firewall_policies`](#policies-d28848) - Optional Block<br>Enhanced Firewall Policy. Ordered List of Enhanced Firewall Policies active<br>See [Enhanced Firewall Policies](#policies-d28848) below.
|
|
281
281
|
|
|
282
282
|
#### Custom Network Config Active Enhanced Firewall Policies Enhanced Firewall Policies
|
|
283
283
|
|
|
284
|
-
An [`enhanced_firewall_policies`](#
|
|
284
|
+
An [`enhanced_firewall_policies`](#policies-d28848) block (within [`custom_network_config.active_enhanced_firewall_policies`](#policies-c4c984)) supports the following:
|
|
285
285
|
|
|
286
|
-
<a id="
|
|
286
|
+
<a id="name-624bec"></a>• [`name`](#name-624bec) - Optional String<br>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
|
|
287
287
|
|
|
288
|
-
<a id="
|
|
288
|
+
<a id="namespace-aff78f"></a>• [`namespace`](#namespace-aff78f) - Optional String<br>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
|
|
289
289
|
|
|
290
|
-
<a id="
|
|
290
|
+
<a id="tenant-f032ee"></a>• [`tenant`](#tenant-f032ee) - Optional String<br>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
|
|
291
291
|
|
|
292
292
|
#### Custom Network Config Active Forward Proxy Policies
|
|
293
293
|
|
|
294
|
-
An [`active_forward_proxy_policies`](#
|
|
294
|
+
An [`active_forward_proxy_policies`](#policies-fbbf75) block (within [`custom_network_config`](#custom-network-config)) supports the following:
|
|
295
295
|
|
|
296
|
-
<a id="
|
|
296
|
+
<a id="policies-3c82d8"></a>• [`forward_proxy_policies`](#policies-3c82d8) - Optional Block<br>Forward Proxy Policies. Ordered List of Forward Proxy Policies active<br>See [Forward Proxy Policies](#policies-3c82d8) below.
|
|
297
297
|
|
|
298
298
|
#### Custom Network Config Active Forward Proxy Policies Forward Proxy Policies
|
|
299
299
|
|
|
300
|
-
A [`forward_proxy_policies`](#
|
|
300
|
+
A [`forward_proxy_policies`](#policies-3c82d8) block (within [`custom_network_config.active_forward_proxy_policies`](#policies-fbbf75)) supports the following:
|
|
301
301
|
|
|
302
|
-
<a id="
|
|
302
|
+
<a id="name-9f15b9"></a>• [`name`](#name-9f15b9) - Optional String<br>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
|
|
303
303
|
|
|
304
|
-
<a id="
|
|
304
|
+
<a id="namespace-7a11c9"></a>• [`namespace`](#namespace-7a11c9) - Optional String<br>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
|
|
305
305
|
|
|
306
|
-
<a id="
|
|
306
|
+
<a id="tenant-71a492"></a>• [`tenant`](#tenant-71a492) - Optional String<br>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
|
|
307
307
|
|
|
308
308
|
#### Custom Network Config Active Network Policies
|
|
309
309
|
|
|
310
|
-
An [`active_network_policies`](#
|
|
310
|
+
An [`active_network_policies`](#policies-e8cb6b) block (within [`custom_network_config`](#custom-network-config)) supports the following:
|
|
311
311
|
|
|
312
|
-
<a id="
|
|
312
|
+
<a id="policies-461fea"></a>• [`network_policies`](#policies-461fea) - Optional Block<br>Firewall Policy. Ordered List of Firewall Policies active for this network firewall<br>See [Network Policies](#policies-461fea) below.
|
|
313
313
|
|
|
314
314
|
#### Custom Network Config Active Network Policies Network Policies
|
|
315
315
|
|
|
316
|
-
A [`network_policies`](#
|
|
316
|
+
A [`network_policies`](#policies-461fea) block (within [`custom_network_config.active_network_policies`](#policies-e8cb6b)) supports the following:
|
|
317
317
|
|
|
318
|
-
<a id="
|
|
318
|
+
<a id="name-8d3a2f"></a>• [`name`](#name-8d3a2f) - Optional String<br>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
|
|
319
319
|
|
|
320
|
-
<a id="
|
|
320
|
+
<a id="namespace-729cde"></a>• [`namespace`](#namespace-729cde) - Optional String<br>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
|
|
321
321
|
|
|
322
|
-
<a id="
|
|
322
|
+
<a id="tenant-bf6185"></a>• [`tenant`](#tenant-bf6185) - Optional String<br>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
|
|
323
323
|
|
|
324
324
|
#### Custom Network Config Global Network List
|
|
325
325
|
|
|
326
|
-
A [`global_network_list`](#
|
|
326
|
+
A [`global_network_list`](#list-452116) block (within [`custom_network_config`](#custom-network-config)) supports the following:
|
|
327
327
|
|
|
328
|
-
<a id="
|
|
328
|
+
<a id="connections-1d58e6"></a>• [`global_network_connections`](#connections-1d58e6) - Optional Block<br>Global Network Connections. Global network connections<br>See [Global Network Connections](#connections-1d58e6) below.
|
|
329
329
|
|
|
330
330
|
#### Custom Network Config Global Network List Global Network Connections
|
|
331
331
|
|
|
332
|
-
A [`global_network_connections`](#
|
|
332
|
+
A [`global_network_connections`](#connections-1d58e6) block (within [`custom_network_config.global_network_list`](#list-452116)) supports the following:
|
|
333
333
|
|
|
334
|
-
<a id="
|
|
334
|
+
<a id="global-dr-1ce43d"></a>• [`sli_to_global_dr`](#global-dr-1ce43d) - Optional Block<br>Global Network. Global network reference for direct connection<br>See [SLI To Global DR](#global-dr-1ce43d) below.
|
|
335
335
|
|
|
336
|
-
<a id="
|
|
336
|
+
<a id="global-dr-b2e24b"></a>• [`slo_to_global_dr`](#global-dr-b2e24b) - Optional Block<br>Global Network. Global network reference for direct connection<br>See [Slo To Global DR](#global-dr-b2e24b) below.
|
|
337
337
|
|
|
338
338
|
#### Custom Network Config Global Network List Global Network Connections SLI To Global DR
|
|
339
339
|
|
|
340
|
-
A [`sli_to_global_dr`](#
|
|
340
|
+
A [`sli_to_global_dr`](#global-dr-1ce43d) block (within [`custom_network_config.global_network_list.global_network_connections`](#connections-1d58e6)) supports the following:
|
|
341
341
|
|
|
342
|
-
<a id="
|
|
342
|
+
<a id="global-vn-92baba"></a>• [`global_vn`](#global-vn-92baba) - Optional Block<br>Object reference. 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<br>See [Global Vn](#global-vn-92baba) below.
|
|
343
343
|
|
|
344
344
|
#### Custom Network Config Global Network List Global Network Connections SLI To Global DR Global Vn
|
|
345
345
|
|
|
346
|
-
A [`global_vn`](#
|
|
346
|
+
A [`global_vn`](#global-vn-92baba) block (within [`custom_network_config.global_network_list.global_network_connections.sli_to_global_dr`](#global-dr-1ce43d)) supports the following:
|
|
347
347
|
|
|
348
|
-
<a id="
|
|
348
|
+
<a id="name-e2ebd7"></a>• [`name`](#name-e2ebd7) - Optional String<br>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
|
|
349
349
|
|
|
350
|
-
<a id="
|
|
350
|
+
<a id="namespace-9d7806"></a>• [`namespace`](#namespace-9d7806) - Optional String<br>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
|
|
351
351
|
|
|
352
|
-
<a id="
|
|
352
|
+
<a id="tenant-ec6824"></a>• [`tenant`](#tenant-ec6824) - Optional String<br>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
|
|
353
353
|
|
|
354
354
|
#### Custom Network Config Global Network List Global Network Connections Slo To Global DR
|
|
355
355
|
|
|
356
|
-
A [`slo_to_global_dr`](#
|
|
356
|
+
A [`slo_to_global_dr`](#global-dr-b2e24b) block (within [`custom_network_config.global_network_list.global_network_connections`](#connections-1d58e6)) supports the following:
|
|
357
357
|
|
|
358
|
-
<a id="
|
|
358
|
+
<a id="global-vn-14c1f3"></a>• [`global_vn`](#global-vn-14c1f3) - Optional Block<br>Object reference. 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<br>See [Global Vn](#global-vn-14c1f3) below.
|
|
359
359
|
|
|
360
360
|
#### Custom Network Config Global Network List Global Network Connections Slo To Global DR Global Vn
|
|
361
361
|
|
|
362
|
-
A [`global_vn`](#
|
|
362
|
+
A [`global_vn`](#global-vn-14c1f3) block (within [`custom_network_config.global_network_list.global_network_connections.slo_to_global_dr`](#global-dr-b2e24b)) supports the following:
|
|
363
363
|
|
|
364
|
-
<a id="
|
|
364
|
+
<a id="name-513269"></a>• [`name`](#name-513269) - Optional String<br>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
|
|
365
365
|
|
|
366
|
-
<a id="
|
|
366
|
+
<a id="namespace-f05ae7"></a>• [`namespace`](#namespace-f05ae7) - Optional String<br>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
|
|
367
367
|
|
|
368
|
-
<a id="
|
|
368
|
+
<a id="tenant-6cb194"></a>• [`tenant`](#tenant-6cb194) - Optional String<br>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
|
|
369
369
|
|
|
370
370
|
#### Custom Network Config Interface List
|
|
371
371
|
|
|
372
372
|
An [`interface_list`](#custom-network-config-interface-list) block (within [`custom_network_config`](#custom-network-config)) supports the following:
|
|
373
373
|
|
|
374
|
-
<a id="
|
|
374
|
+
<a id="interfaces-e1b75d"></a>• [`interfaces`](#interfaces-e1b75d) - Optional Block<br>List of Interface. Configure network interfaces for this App Stack site<br>See [Interfaces](#interfaces-e1b75d) below.
|
|
375
375
|
|
|
376
376
|
#### Custom Network Config Interface List Interfaces
|
|
377
377
|
|
|
378
|
-
An [`interfaces`](#
|
|
378
|
+
An [`interfaces`](#interfaces-e1b75d) block (within [`custom_network_config.interface_list`](#custom-network-config-interface-list)) supports the following:
|
|
379
379
|
|
|
380
|
-
<a id="
|
|
380
|
+
<a id="disabled-8e6c58"></a>• [`dc_cluster_group_connectivity_interface_disabled`](#disabled-8e6c58) - Optional Block<br>Enable this option
|
|
381
381
|
|
|
382
|
-
<a id="
|
|
382
|
+
<a id="enabled-976919"></a>• [`dc_cluster_group_connectivity_interface_enabled`](#enabled-976919) - Optional Block<br>Enable this option
|
|
383
383
|
|
|
384
|
-
<a id="
|
|
384
|
+
<a id="interface-5e9f68"></a>• [`dedicated_interface`](#interface-5e9f68) - Optional Block<br>Dedicated Interface. Dedicated Interface Configuration<br>See [Dedicated Interface](#interface-5e9f68) below.
|
|
385
385
|
|
|
386
|
-
<a id="
|
|
386
|
+
<a id="interface-a7c718"></a>• [`dedicated_management_interface`](#interface-a7c718) - Optional Block<br>Dedicated Management Interface. Dedicated Interface Configuration<br>See [Dedicated Management Interface](#interface-a7c718) below.
|
|
387
387
|
|
|
388
|
-
<a id="
|
|
388
|
+
<a id="spec-5c5d10"></a>• [`description_spec`](#spec-5c5d10) - Optional String<br>Interface Description. Description for this Interface
|
|
389
389
|
|
|
390
|
-
<a id="
|
|
390
|
+
<a id="interface-40e35f"></a>• [`ethernet_interface`](#interface-40e35f) - Optional Block<br>Ethernet Interface. Ethernet Interface Configuration<br>See [Ethernet Interface](#interface-40e35f) below.
|
|
391
391
|
|
|
392
|
-
<a id="
|
|
392
|
+
<a id="labels-eb9e14"></a>• [`labels`](#labels-eb9e14) - Optional Block<br>Interface Labels. Add Labels for this Interface, these labels can be used in firewall policy
|
|
393
393
|
|
|
394
|
-
<a id="
|
|
394
|
+
<a id="interface-b0b4f4"></a>• [`tunnel_interface`](#interface-b0b4f4) - Optional Block<br>Tunnel Interface. Tunnel Interface Configuration<br>See [Tunnel Interface](#interface-b0b4f4) below.
|
|
395
395
|
|
|
396
396
|
#### Custom Network Config Interface List Interfaces Dedicated Interface
|
|
397
397
|
|
|
398
|
-
A [`dedicated_interface`](#
|
|
398
|
+
A [`dedicated_interface`](#interface-5e9f68) block (within [`custom_network_config.interface_list.interfaces`](#interfaces-e1b75d)) supports the following:
|
|
399
399
|
|
|
400
|
-
<a id="
|
|
400
|
+
<a id="cluster-436281"></a>• [`cluster`](#cluster-436281) - Optional Block<br>Enable this option
|
|
401
401
|
|
|
402
|
-
<a id="
|
|
402
|
+
<a id="device-802885"></a>• [`device`](#device-802885) - Optional String<br>Interface Device. Name of the device for which interface is configured. Use wwan0 for 4G/LTE
|
|
403
403
|
|
|
404
|
-
<a id="
|
|
404
|
+
<a id="primary-ef7ed0"></a>• [`is_primary`](#primary-ef7ed0) - Optional Block<br>Enable this option
|
|
405
405
|
|
|
406
|
-
<a id="
|
|
406
|
+
<a id="monitor-ca5854"></a>• [`monitor`](#monitor-ca5854) - Optional Block<br>Link Quality Monitoring Configuration. Link Quality Monitoring configuration for a network interface
|
|
407
407
|
|
|
408
|
-
<a id="
|
|
408
|
+
<a id="disabled-9c55e1"></a>• [`monitor_disabled`](#disabled-9c55e1) - Optional Block<br>Enable this option
|
|
409
409
|
|
|
410
|
-
<a id="
|
|
410
|
+
<a id="mtu-9052e0"></a>• [`mtu`](#mtu-9052e0) - Optional Number<br>Maximum Packet Size (MTU). Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384
|
|
411
411
|
|
|
412
|
-
<a id="
|
|
412
|
+
<a id="node-efcfad"></a>• [`node`](#node-efcfad) - Optional String<br>Specific Node. Configuration will apply to a device on the given node of the site
|
|
413
413
|
|
|
414
|
-
<a id="
|
|
414
|
+
<a id="primary-665cf6"></a>• [`not_primary`](#primary-665cf6) - Optional Block<br>Enable this option
|
|
415
415
|
|
|
416
|
-
<a id="
|
|
416
|
+
<a id="priority-095fd3"></a>• [`priority`](#priority-095fd3) - Optional Number<br>Priority. Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority
|
|
417
417
|
|
|
418
418
|
#### Custom Network Config Interface List Interfaces Dedicated Management Interface
|
|
419
419
|
|
|
420
|
-
A [`dedicated_management_interface`](#
|
|
420
|
+
A [`dedicated_management_interface`](#interface-a7c718) block (within [`custom_network_config.interface_list.interfaces`](#interfaces-e1b75d)) supports the following:
|
|
421
421
|
|
|
422
|
-
<a id="
|
|
422
|
+
<a id="cluster-cc7866"></a>• [`cluster`](#cluster-cc7866) - Optional Block<br>Enable this option
|
|
423
423
|
|
|
424
|
-
<a id="
|
|
424
|
+
<a id="device-52578d"></a>• [`device`](#device-52578d) - Optional String<br>Interface Device. Name of the device for which interface is configured
|
|
425
425
|
|
|
426
|
-
<a id="
|
|
426
|
+
<a id="mtu-6c0078"></a>• [`mtu`](#mtu-6c0078) - Optional Number<br>Maximum Packet Size (MTU). Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384
|
|
427
427
|
|
|
428
|
-
<a id="
|
|
428
|
+
<a id="node-ee28ff"></a>• [`node`](#node-ee28ff) - Optional String<br>Specific Node. Configuration will apply to a device on the given node of the site
|
|
429
429
|
|
|
430
430
|
#### Custom Network Config Interface List Interfaces Ethernet Interface
|
|
431
431
|
|
|
432
|
-
An [`ethernet_interface`](#
|
|
432
|
+
An [`ethernet_interface`](#interface-40e35f) block (within [`custom_network_config.interface_list.interfaces`](#interfaces-e1b75d)) supports the following:
|
|
433
433
|
|
|
434
|
-
<a id="
|
|
434
|
+
<a id="cluster-e93c1d"></a>• [`cluster`](#cluster-e93c1d) - Optional Block<br>Enable this option
|
|
435
435
|
|
|
436
|
-
<a id="
|
|
436
|
+
<a id="device-d0a8a3"></a>• [`device`](#device-d0a8a3) - Optional String<br>Ethernet Device. Interface configuration for the ethernet device
|
|
437
437
|
|
|
438
|
-
<a id="
|
|
438
|
+
<a id="client-bc1e31"></a>• [`dhcp_client`](#client-bc1e31) - Optional Block<br>Enable this option
|
|
439
439
|
|
|
440
|
-
<a id="
|
|
440
|
+
<a id="server-708f5c"></a>• [`dhcp_server`](#server-708f5c) - Optional Block<br>DHCPServerParametersType<br>See [DHCP Server](#server-708f5c) below.
|
|
441
441
|
|
|
442
|
-
<a id="
|
|
442
|
+
<a id="config-7aa593"></a>• [`ipv6_auto_config`](#config-7aa593) - Optional Block<br>IPV6AutoConfigType<br>See [IPv6 Auto Config](#config-7aa593) below.
|
|
443
443
|
|
|
444
|
-
<a id="
|
|
444
|
+
<a id="primary-2dfad3"></a>• [`is_primary`](#primary-2dfad3) - Optional Block<br>Enable this option
|
|
445
445
|
|
|
446
|
-
<a id="
|
|
446
|
+
<a id="monitor-90080f"></a>• [`monitor`](#monitor-90080f) - Optional Block<br>Link Quality Monitoring Configuration. Link Quality Monitoring configuration for a network interface
|
|
447
447
|
|
|
448
|
-
<a id="
|
|
448
|
+
<a id="disabled-4a3c3e"></a>• [`monitor_disabled`](#disabled-4a3c3e) - Optional Block<br>Enable this option
|
|
449
449
|
|
|
450
|
-
<a id="
|
|
450
|
+
<a id="mtu-1a1a52"></a>• [`mtu`](#mtu-1a1a52) - Optional Number<br>Maximum Packet Size (MTU). Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384
|
|
451
451
|
|
|
452
|
-
<a id="
|
|
452
|
+
<a id="address-1b467e"></a>• [`no_ipv6_address`](#address-1b467e) - Optional Block<br>Enable this option
|
|
453
453
|
|
|
454
|
-
<a id="
|
|
454
|
+
<a id="node-c8a85c"></a>• [`node`](#node-c8a85c) - Optional String<br>Specific Node. Configuration will apply to a device on the given node
|
|
455
455
|
|
|
456
|
-
<a id="
|
|
456
|
+
<a id="primary-e4637a"></a>• [`not_primary`](#primary-e4637a) - Optional Block<br>Enable this option
|
|
457
457
|
|
|
458
|
-
<a id="
|
|
458
|
+
<a id="priority-6e05a8"></a>• [`priority`](#priority-6e05a8) - Optional Number<br>Priority. Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority
|
|
459
459
|
|
|
460
|
-
<a id="
|
|
460
|
+
<a id="network-ca6818"></a>• [`site_local_inside_network`](#network-ca6818) - Optional Block<br>Enable this option
|
|
461
461
|
|
|
462
|
-
<a id="
|
|
462
|
+
<a id="network-a73ac7"></a>• [`site_local_network`](#network-a73ac7) - Optional Block<br>Enable this option
|
|
463
463
|
|
|
464
|
-
<a id="
|
|
464
|
+
<a id="static-ip-5070d8"></a>• [`static_ip`](#static-ip-5070d8) - Optional Block<br>Static IP Parameters. Configure Static IP parameters<br>See [Static IP](#static-ip-5070d8) below.
|
|
465
465
|
|
|
466
|
-
<a id="
|
|
466
|
+
<a id="address-e03fbb"></a>• [`static_ipv6_address`](#address-e03fbb) - Optional Block<br>Static IP Parameters. Configure Static IP parameters<br>See [Static IPv6 Address](#address-e03fbb) below.
|
|
467
467
|
|
|
468
|
-
<a id="
|
|
468
|
+
<a id="network-667c39"></a>• [`storage_network`](#network-667c39) - Optional Block<br>Enable this option
|
|
469
469
|
|
|
470
|
-
<a id="
|
|
470
|
+
<a id="untagged-ed4638"></a>• [`untagged`](#untagged-ed4638) - Optional Block<br>Enable this option
|
|
471
471
|
|
|
472
|
-
<a id="
|
|
472
|
+
<a id="vlan-id-77f95a"></a>• [`vlan_id`](#vlan-id-77f95a) - Optional Number<br>VLAN ID. Configure a VLAN tagged ethernet interface
|
|
473
473
|
|
|
474
474
|
#### Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server
|
|
475
475
|
|
|
476
|
-
A [`dhcp_server`](#
|
|
476
|
+
A [`dhcp_server`](#server-708f5c) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface`](#interface-40e35f)) supports the following:
|
|
477
477
|
|
|
478
|
-
<a id="
|
|
478
|
+
<a id="end-37cedd"></a>• [`automatic_from_end`](#end-37cedd) - Optional Block<br>Enable this option
|
|
479
479
|
|
|
480
|
-
<a id="
|
|
480
|
+
<a id="start-bd22b5"></a>• [`automatic_from_start`](#start-bd22b5) - Optional Block<br>Enable this option
|
|
481
481
|
|
|
482
|
-
<a id="
|
|
482
|
+
<a id="networks-d76609"></a>• [`dhcp_networks`](#networks-d76609) - Optional Block<br>DHCP Networks. List of networks from which DHCP Server can allocate IPv4 Addresses<br>See [DHCP Networks](#networks-d76609) below.
|
|
483
483
|
|
|
484
|
-
<a id="
|
|
484
|
+
<a id="map-8afba3"></a>• [`fixed_ip_map`](#map-8afba3) - Optional Block<br>Fixed MAC Address to IPv4 Assignments. Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client
|
|
485
485
|
|
|
486
|
-
<a id="
|
|
486
|
+
<a id="map-0b5090"></a>• [`interface_ip_map`](#map-0b5090) - Optional Block<br>Interface IPv4 Assignments. Specify static IPv4 addresses per node<br>See [Interface IP Map](#map-0b5090) below.
|
|
487
487
|
|
|
488
488
|
#### Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server DHCP Networks
|
|
489
489
|
|
|
490
|
-
A [`dhcp_networks`](#
|
|
490
|
+
A [`dhcp_networks`](#networks-d76609) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.dhcp_server`](#server-708f5c)) supports the following:
|
|
491
491
|
|
|
492
|
-
<a id="
|
|
492
|
+
<a id="address-f00b53"></a>• [`dgw_address`](#address-f00b53) - Optional String<br>Static IPv4 Configuration. Enter a IPv4 address from the network prefix to be used as the default gateway
|
|
493
493
|
|
|
494
|
-
<a id="
|
|
494
|
+
<a id="address-b6c318"></a>• [`dns_address`](#address-b6c318) - Optional String<br>Static IPv4 Configuration. Enter a IPv4 address from the network prefix to be used as the DNS server
|
|
495
495
|
|
|
496
|
-
<a id="
|
|
496
|
+
<a id="address-071586"></a>• [`first_address`](#address-071586) - Optional Block<br>Enable this option
|
|
497
497
|
|
|
498
|
-
<a id="
|
|
498
|
+
<a id="address-fe3f46"></a>• [`last_address`](#address-fe3f46) - Optional Block<br>Enable this option
|
|
499
499
|
|
|
500
|
-
<a id="
|
|
500
|
+
<a id="prefix-c6abca"></a>• [`network_prefix`](#prefix-c6abca) - Optional String<br>Network Prefix. Set the network prefix for the site. ex: 10.1.1.0/24
|
|
501
501
|
|
|
502
|
-
<a id="
|
|
502
|
+
<a id="settings-23473c"></a>• [`pool_settings`](#settings-23473c) - Optional String Defaults to `INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`<br>Possible values are `INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`, `EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`<br>[Enum: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS|EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS] Interface Network Type. Identifies the how to pick the network for Interface. Address ranges in DHCP pool list are used for IP Address allocation Address ranges in DHCP pool list are excluded from IP Address allocation
|
|
503
503
|
|
|
504
|
-
<a id="
|
|
504
|
+
<a id="pools-63ec82"></a>• [`pools`](#pools-63ec82) - Optional Block<br>DHCP Pools. List of non overlapping IP address ranges<br>See [Pools](#pools-63ec82) below.
|
|
505
505
|
|
|
506
|
-
<a id="
|
|
506
|
+
<a id="dgw-3baafe"></a>• [`same_as_dgw`](#dgw-3baafe) - Optional Block<br>Enable this option
|
|
507
507
|
|
|
508
508
|
#### Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server DHCP Networks Pools
|
|
509
509
|
|
|
510
|
-
A [`pools`](#
|
|
510
|
+
A [`pools`](#pools-63ec82) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.dhcp_server.dhcp_networks`](#networks-d76609)) supports the following:
|
|
511
511
|
|
|
512
|
-
<a id="
|
|
512
|
+
<a id="end-ip-94cd56"></a>• [`end_ip`](#end-ip-94cd56) - Optional String<br>Ending 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
|
|
513
513
|
|
|
514
|
-
<a id="
|
|
514
|
+
<a id="start-ip-ac7cb4"></a>• [`start_ip`](#start-ip-ac7cb4) - Optional String<br>Starting 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
|
|
515
515
|
|
|
516
516
|
#### Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server Interface IP Map
|
|
517
517
|
|
|
518
|
-
An [`interface_ip_map`](#
|
|
518
|
+
An [`interface_ip_map`](#map-0b5090) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.dhcp_server`](#server-708f5c)) supports the following:
|
|
519
519
|
|
|
520
|
-
<a id="
|
|
520
|
+
<a id="map-dd31a5"></a>• [`interface_ip_map`](#map-dd31a5) - Optional Block<br>Site:Node to IPv4 Address Mapping. Specify static IPv4 addresses per site:node
|
|
521
521
|
|
|
522
522
|
#### Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config
|
|
523
523
|
|
|
524
|
-
An [`ipv6_auto_config`](#
|
|
524
|
+
An [`ipv6_auto_config`](#config-7aa593) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface`](#interface-40e35f)) supports the following:
|
|
525
525
|
|
|
526
|
-
<a id="
|
|
526
|
+
<a id="host-d5ba83"></a>• [`host`](#host-d5ba83) - Optional Block<br>Enable this option
|
|
527
527
|
|
|
528
|
-
<a id="
|
|
528
|
+
<a id="router-a6963c"></a>• [`router`](#router-a6963c) - Optional Block<br>IPV6AutoConfigRouterType<br>See [Router](#router-a6963c) below.
|
|
529
529
|
|
|
530
530
|
#### Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router
|
|
531
531
|
|
|
532
|
-
A [`router`](#
|
|
532
|
+
A [`router`](#router-a6963c) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.ipv6_auto_config`](#config-7aa593)) supports the following:
|
|
533
533
|
|
|
534
|
-
<a id="
|
|
534
|
+
<a id="config-037271"></a>• [`dns_config`](#config-037271) - Optional Block<br>IPV6DnsConfig<br>See [DNS Config](#config-037271) below.
|
|
535
535
|
|
|
536
|
-
<a id="
|
|
536
|
+
<a id="prefix-3548e5"></a>• [`network_prefix`](#prefix-3548e5) - Optional String<br>Network Prefix. Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862
|
|
537
537
|
|
|
538
|
-
<a id="
|
|
538
|
+
<a id="stateful-116682"></a>• [`stateful`](#stateful-116682) - Optional Block<br>DHCPIPV6 Stateful Server<br>See [Stateful](#stateful-116682) below.
|
|
539
539
|
|
|
540
540
|
#### Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router DNS Config
|
|
541
541
|
|
|
542
|
-
A [`dns_config`](#
|
|
542
|
+
A [`dns_config`](#config-037271) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.ipv6_auto_config.router`](#router-a6963c)) supports the following:
|
|
543
543
|
|
|
544
|
-
<a id="
|
|
544
|
+
<a id="list-c0116e"></a>• [`configured_list`](#list-c0116e) - Optional Block<br>IPV6DnsList<br>See [Configured List](#list-c0116e) below.
|
|
545
545
|
|
|
546
|
-
<a id="
|
|
546
|
+
<a id="dns-05ebf1"></a>• [`local_dns`](#dns-05ebf1) - Optional Block<br>IPV6LocalDnsAddress<br>See [Local DNS](#dns-05ebf1) below.
|
|
547
547
|
|
|
548
548
|
#### Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router DNS Config Configured List
|
|
549
549
|
|
|
550
|
-
A [`configured_list`](#
|
|
550
|
+
A [`configured_list`](#list-c0116e) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.ipv6_auto_config.router.dns_config`](#config-037271)) supports the following:
|
|
551
551
|
|
|
552
|
-
<a id="
|
|
552
|
+
<a id="list-619661"></a>• [`dns_list`](#list-619661) - Optional List<br>DNS List. List of IPv6 Addresses acting as DNS servers
|
|
553
553
|
|
|
554
554
|
#### Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router DNS Config Local DNS
|
|
555
555
|
|
|
556
|
-
A [`local_dns`](#
|
|
556
|
+
A [`local_dns`](#dns-05ebf1) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.ipv6_auto_config.router.dns_config`](#config-037271)) supports the following:
|
|
557
557
|
|
|
558
|
-
<a id="
|
|
558
|
+
<a id="address-14b952"></a>• [`configured_address`](#address-14b952) - Optional String<br>Configured Address. Configured address from the network prefix is chosen as DNS server
|
|
559
559
|
|
|
560
|
-
<a id="
|
|
560
|
+
<a id="address-a3332b"></a>• [`first_address`](#address-a3332b) - Optional Block<br>Enable this option
|
|
561
561
|
|
|
562
|
-
<a id="
|
|
562
|
+
<a id="address-b87aff"></a>• [`last_address`](#address-b87aff) - Optional Block<br>Enable this option
|
|
563
563
|
|
|
564
564
|
#### Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful
|
|
565
565
|
|
|
566
|
-
A [`stateful`](#
|
|
566
|
+
A [`stateful`](#stateful-116682) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.ipv6_auto_config.router`](#router-a6963c)) supports the following:
|
|
567
567
|
|
|
568
|
-
<a id="
|
|
568
|
+
<a id="end-d40179"></a>• [`automatic_from_end`](#end-d40179) - Optional Block<br>Enable this option
|
|
569
569
|
|
|
570
|
-
<a id="
|
|
570
|
+
<a id="start-406059"></a>• [`automatic_from_start`](#start-406059) - Optional Block<br>Enable this option
|
|
571
571
|
|
|
572
|
-
<a id="
|
|
572
|
+
<a id="networks-654d11"></a>• [`dhcp_networks`](#networks-654d11) - Optional Block<br>DHCP IPv6 Networks. List of networks from which DHCP server can allocate IP addresses<br>See [DHCP Networks](#networks-654d11) below.
|
|
573
573
|
|
|
574
|
-
<a id="
|
|
574
|
+
<a id="map-3fb1f7"></a>• [`fixed_ip_map`](#map-3fb1f7) - Optional Block<br>Fixed MAC Address to 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
|
|
575
575
|
|
|
576
|
-
<a id="
|
|
576
|
+
<a id="map-c30b96"></a>• [`interface_ip_map`](#map-c30b96) - Optional Block<br>Interface IPv6 Assignments. Map of Interface IPv6 assignments per node<br>See [Interface IP Map](#map-c30b96) below.
|
|
577
577
|
|
|
578
578
|
#### Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful DHCP Networks
|
|
579
579
|
|
|
580
|
-
A [`dhcp_networks`](#
|
|
580
|
+
A [`dhcp_networks`](#networks-654d11) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.ipv6_auto_config.router.stateful`](#stateful-116682)) supports the following:
|
|
581
581
|
|
|
582
|
-
<a id="
|
|
582
|
+
<a id="prefix-443ea7"></a>• [`network_prefix`](#prefix-443ea7) - Optional String<br>Network Prefix. Network Prefix to be used for IPv6 address auto configuration
|
|
583
583
|
|
|
584
|
-
<a id="
|
|
584
|
+
<a id="settings-010139"></a>• [`pool_settings`](#settings-010139) - Optional String Defaults to `INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`<br>Possible values are `INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`, `EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`<br>[Enum: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS|EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS] Interface Network Type. Identifies the how to pick the network for Interface. Address ranges in DHCP pool list are used for IP Address allocation Address ranges in DHCP pool list are excluded from IP Address allocation
|
|
585
585
|
|
|
586
|
-
<a id="
|
|
586
|
+
<a id="pools-96229f"></a>• [`pools`](#pools-96229f) - Optional Block<br>DHCP Pools. List of non overlapping IP address ranges<br>See [Pools](#pools-96229f) below.
|
|
587
587
|
|
|
588
588
|
#### Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful DHCP Networks Pools
|
|
589
589
|
|
|
590
|
-
A [`pools`](#
|
|
590
|
+
A [`pools`](#pools-96229f) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.ipv6_auto_config.router.stateful.dhcp_networks`](#networks-654d11)) supports the following:
|
|
591
591
|
|
|
592
|
-
<a id="
|
|
592
|
+
<a id="end-ip-94c760"></a>• [`end_ip`](#end-ip-94c760) - Optional String<br>Ending IPv6. Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix
|
|
593
593
|
|
|
594
|
-
<a id="
|
|
594
|
+
<a id="start-ip-020c36"></a>• [`start_ip`](#start-ip-020c36) - Optional String<br>Starting 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
|
|
595
595
|
|
|
596
596
|
#### Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful Interface IP Map
|
|
597
597
|
|
|
598
|
-
An [`interface_ip_map`](#
|
|
598
|
+
An [`interface_ip_map`](#map-c30b96) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.ipv6_auto_config.router.stateful`](#stateful-116682)) supports the following:
|
|
599
599
|
|
|
600
|
-
<a id="
|
|
600
|
+
<a id="map-d1f8c9"></a>• [`interface_ip_map`](#map-d1f8c9) - Optional Block<br>Site:Node to IPv6 Mapping. Map of Site:Node to IPv6 address
|
|
601
601
|
|
|
602
602
|
#### Custom Network Config Interface List Interfaces Ethernet Interface Static IP
|
|
603
603
|
|
|
604
|
-
A [`static_ip`](#
|
|
604
|
+
A [`static_ip`](#static-ip-5070d8) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface`](#interface-40e35f)) supports the following:
|
|
605
605
|
|
|
606
|
-
<a id="
|
|
606
|
+
<a id="static-ip-f33200"></a>• [`cluster_static_ip`](#static-ip-f33200) - Optional Block<br>Cluster: Static IP Parameters. Configure Static IP parameters for cluster<br>See [Cluster Static IP](#static-ip-f33200) below.
|
|
607
607
|
|
|
608
|
-
<a id="
|
|
608
|
+
<a id="static-ip-1d2ad5"></a>• [`node_static_ip`](#static-ip-1d2ad5) - Optional Block<br>Node: Static IP Parameters. Configure Static IP parameters for a node<br>See [Node Static IP](#static-ip-1d2ad5) below.
|
|
609
609
|
|
|
610
610
|
#### Custom Network Config Interface List Interfaces Ethernet Interface Static IP Cluster Static IP
|
|
611
611
|
|
|
612
|
-
A [`cluster_static_ip`](#
|
|
612
|
+
A [`cluster_static_ip`](#static-ip-f33200) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.static_ip`](#static-ip-5070d8)) supports the following:
|
|
613
613
|
|
|
614
|
-
<a id="
|
|
614
|
+
<a id="map-9a2bd5"></a>• [`interface_ip_map`](#map-9a2bd5) - Optional Block<br>Node to IP Mapping. Map of Node to Static IP configuration value, Key:Node, Value:IP Address
|
|
615
615
|
|
|
616
616
|
#### Custom Network Config Interface List Interfaces Ethernet Interface Static IP Node Static IP
|
|
617
617
|
|
|
618
|
-
A [`node_static_ip`](#
|
|
618
|
+
A [`node_static_ip`](#static-ip-1d2ad5) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.static_ip`](#static-ip-5070d8)) supports the following:
|
|
619
619
|
|
|
620
|
-
<a id="
|
|
620
|
+
<a id="default-gw-3aba5b"></a>• [`default_gw`](#default-gw-3aba5b) - Optional String<br>Default Gateway. IP address of the default gateway
|
|
621
621
|
|
|
622
|
-
<a id="
|
|
622
|
+
<a id="address-a00adf"></a>• [`ip_address`](#address-a00adf) - Optional String<br>IP address/Prefix Length. IP address of the interface and prefix length
|
|
623
623
|
|
|
624
624
|
#### Custom Network Config Interface List Interfaces Ethernet Interface Static IPv6 Address
|
|
625
625
|
|
|
626
|
-
A [`static_ipv6_address`](#
|
|
626
|
+
A [`static_ipv6_address`](#address-e03fbb) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface`](#interface-40e35f)) supports the following:
|
|
627
627
|
|
|
628
|
-
<a id="
|
|
628
|
+
<a id="static-ip-46d326"></a>• [`cluster_static_ip`](#static-ip-46d326) - Optional Block<br>Cluster: Static IP Parameters. Configure Static IP parameters for cluster<br>See [Cluster Static IP](#static-ip-46d326) below.
|
|
629
629
|
|
|
630
|
-
<a id="
|
|
630
|
+
<a id="static-ip-3e9e31"></a>• [`node_static_ip`](#static-ip-3e9e31) - Optional Block<br>Node: Static IP Parameters. Configure Static IP parameters for a node<br>See [Node Static IP](#static-ip-3e9e31) below.
|
|
631
631
|
|
|
632
632
|
#### Custom Network Config Interface List Interfaces Ethernet Interface Static IPv6 Address Cluster Static IP
|
|
633
633
|
|
|
634
|
-
A [`cluster_static_ip`](#
|
|
634
|
+
A [`cluster_static_ip`](#static-ip-46d326) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.static_ipv6_address`](#address-e03fbb)) supports the following:
|
|
635
635
|
|
|
636
|
-
<a id="
|
|
636
|
+
<a id="map-4cd1b3"></a>• [`interface_ip_map`](#map-4cd1b3) - Optional Block<br>Node to IP Mapping. Map of Node to Static IP configuration value, Key:Node, Value:IP Address
|
|
637
637
|
|
|
638
638
|
#### Custom Network Config Interface List Interfaces Ethernet Interface Static IPv6 Address Node Static IP
|
|
639
639
|
|
|
640
|
-
A [`node_static_ip`](#
|
|
640
|
+
A [`node_static_ip`](#static-ip-3e9e31) block (within [`custom_network_config.interface_list.interfaces.ethernet_interface.static_ipv6_address`](#address-e03fbb)) supports the following:
|
|
641
641
|
|
|
642
|
-
<a id="
|
|
642
|
+
<a id="default-gw-00d6df"></a>• [`default_gw`](#default-gw-00d6df) - Optional String<br>Default Gateway. IP address of the default gateway
|
|
643
643
|
|
|
644
|
-
<a id="
|
|
644
|
+
<a id="address-2cb1af"></a>• [`ip_address`](#address-2cb1af) - Optional String<br>IP address/Prefix Length. IP address of the interface and prefix length
|
|
645
645
|
|
|
646
646
|
#### Custom Network Config Interface List Interfaces Tunnel Interface
|
|
647
647
|
|
|
648
|
-
A [`tunnel_interface`](#
|
|
648
|
+
A [`tunnel_interface`](#interface-b0b4f4) block (within [`custom_network_config.interface_list.interfaces`](#interfaces-e1b75d)) supports the following:
|
|
649
649
|
|
|
650
|
-
<a id="
|
|
650
|
+
<a id="mtu-039bb2"></a>• [`mtu`](#mtu-039bb2) - Optional Number<br>Maximum Packet Size (MTU). Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384
|
|
651
651
|
|
|
652
|
-
<a id="
|
|
652
|
+
<a id="node-a23d57"></a>• [`node`](#node-a23d57) - Optional String<br>Specific Node. Configuration will apply to a given device on the given node
|
|
653
653
|
|
|
654
|
-
<a id="
|
|
654
|
+
<a id="priority-12bf57"></a>• [`priority`](#priority-12bf57) - Optional Number<br>Priority. Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority
|
|
655
655
|
|
|
656
|
-
<a id="
|
|
656
|
+
<a id="network-cec884"></a>• [`site_local_inside_network`](#network-cec884) - Optional Block<br>Enable this option
|
|
657
657
|
|
|
658
|
-
<a id="
|
|
658
|
+
<a id="network-af012f"></a>• [`site_local_network`](#network-af012f) - Optional Block<br>Enable this option
|
|
659
659
|
|
|
660
|
-
<a id="
|
|
660
|
+
<a id="static-ip-72aece"></a>• [`static_ip`](#static-ip-72aece) - Optional Block<br>Static IP Parameters. Configure Static IP parameters<br>See [Static IP](#static-ip-72aece) below.
|
|
661
661
|
|
|
662
|
-
<a id="
|
|
662
|
+
<a id="tunnel-09a8a9"></a>• [`tunnel`](#tunnel-09a8a9) - Optional Block<br>Object reference. 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<br>See [Tunnel](#tunnel-09a8a9) below.
|
|
663
663
|
|
|
664
664
|
#### Custom Network Config Interface List Interfaces Tunnel Interface Static IP
|
|
665
665
|
|
|
666
|
-
A [`static_ip`](#
|
|
666
|
+
A [`static_ip`](#static-ip-72aece) block (within [`custom_network_config.interface_list.interfaces.tunnel_interface`](#interface-b0b4f4)) supports the following:
|
|
667
667
|
|
|
668
|
-
<a id="
|
|
668
|
+
<a id="static-ip-2791e9"></a>• [`cluster_static_ip`](#static-ip-2791e9) - Optional Block<br>Cluster: Static IP Parameters. Configure Static IP parameters for cluster<br>See [Cluster Static IP](#static-ip-2791e9) below.
|
|
669
669
|
|
|
670
|
-
<a id="
|
|
670
|
+
<a id="static-ip-3e9545"></a>• [`node_static_ip`](#static-ip-3e9545) - Optional Block<br>Node: Static IP Parameters. Configure Static IP parameters for a node<br>See [Node Static IP](#static-ip-3e9545) below.
|
|
671
671
|
|
|
672
672
|
#### Custom Network Config Interface List Interfaces Tunnel Interface Static IP Cluster Static IP
|
|
673
673
|
|
|
674
|
-
A [`cluster_static_ip`](#
|
|
674
|
+
A [`cluster_static_ip`](#static-ip-2791e9) block (within [`custom_network_config.interface_list.interfaces.tunnel_interface.static_ip`](#static-ip-72aece)) supports the following:
|
|
675
675
|
|
|
676
|
-
<a id="
|
|
676
|
+
<a id="map-741cd6"></a>• [`interface_ip_map`](#map-741cd6) - Optional Block<br>Node to IP Mapping. Map of Node to Static IP configuration value, Key:Node, Value:IP Address
|
|
677
677
|
|
|
678
678
|
#### Custom Network Config Interface List Interfaces Tunnel Interface Static IP Node Static IP
|
|
679
679
|
|
|
680
|
-
A [`node_static_ip`](#
|
|
680
|
+
A [`node_static_ip`](#static-ip-3e9545) block (within [`custom_network_config.interface_list.interfaces.tunnel_interface.static_ip`](#static-ip-72aece)) supports the following:
|
|
681
681
|
|
|
682
|
-
<a id="
|
|
682
|
+
<a id="default-gw-89c792"></a>• [`default_gw`](#default-gw-89c792) - Optional String<br>Default Gateway. IP address of the default gateway
|
|
683
683
|
|
|
684
|
-
<a id="
|
|
684
|
+
<a id="address-73fff7"></a>• [`ip_address`](#address-73fff7) - Optional String<br>IP address/Prefix Length. IP address of the interface and prefix length
|
|
685
685
|
|
|
686
686
|
#### Custom Network Config Interface List Interfaces Tunnel Interface Tunnel
|
|
687
687
|
|
|
688
|
-
A [`tunnel`](#
|
|
688
|
+
A [`tunnel`](#tunnel-09a8a9) block (within [`custom_network_config.interface_list.interfaces.tunnel_interface`](#interface-b0b4f4)) supports the following:
|
|
689
689
|
|
|
690
|
-
<a id="
|
|
690
|
+
<a id="name-1cc821"></a>• [`name`](#name-1cc821) - Optional String<br>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
|
|
691
691
|
|
|
692
|
-
<a id="
|
|
692
|
+
<a id="namespace-9589b4"></a>• [`namespace`](#namespace-9589b4) - Optional String<br>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
|
|
693
693
|
|
|
694
|
-
<a id="
|
|
694
|
+
<a id="tenant-ade79e"></a>• [`tenant`](#tenant-ade79e) - Optional String<br>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
|
|
695
695
|
|
|
696
696
|
#### Custom Network Config SLI Config
|
|
697
697
|
|
|
698
698
|
A [`sli_config`](#custom-network-config-sli-config) block (within [`custom_network_config`](#custom-network-config)) supports the following:
|
|
699
699
|
|
|
700
|
-
<a id="
|
|
700
|
+
<a id="routes-ece448"></a>• [`no_static_routes`](#routes-ece448) - Optional Block<br>Enable this option
|
|
701
701
|
|
|
702
|
-
<a id="
|
|
702
|
+
<a id="routes-ef5627"></a>• [`no_v6_static_routes`](#routes-ef5627) - Optional Block<br>Enable this option
|
|
703
703
|
|
|
704
|
-
<a id="
|
|
704
|
+
<a id="routes-766a73"></a>• [`static_routes`](#routes-766a73) - Optional Block<br>Static Routes List. List of static routes<br>See [Static Routes](#routes-766a73) below.
|
|
705
705
|
|
|
706
|
-
<a id="
|
|
706
|
+
<a id="routes-3c3781"></a>• [`static_v6_routes`](#routes-3c3781) - Optional Block<br>Static IPv6 Routes List. List of IPv6 static routes<br>See [Static V6 Routes](#routes-3c3781) below.
|
|
707
707
|
|
|
708
708
|
#### Custom Network Config SLI Config Static Routes
|
|
709
709
|
|
|
710
|
-
A [`static_routes`](#
|
|
710
|
+
A [`static_routes`](#routes-766a73) block (within [`custom_network_config.sli_config`](#custom-network-config-sli-config)) supports the following:
|
|
711
711
|
|
|
712
|
-
<a id="
|
|
712
|
+
<a id="routes-75c512"></a>• [`static_routes`](#routes-75c512) - Optional Block<br>Static Routes. List of static routes<br>See [Static Routes](#routes-75c512) below.
|
|
713
713
|
|
|
714
714
|
#### Custom Network Config SLI Config Static Routes Static Routes
|
|
715
715
|
|
|
716
|
-
A [`static_routes`](#
|
|
716
|
+
A [`static_routes`](#routes-75c512) block (within [`custom_network_config.sli_config.static_routes`](#routes-766a73)) supports the following:
|
|
717
717
|
|
|
718
|
-
<a id="
|
|
718
|
+
<a id="attrs-ef92a5"></a>• [`attrs`](#attrs-ef92a5) - Optional List Defaults to `ROUTE_ATTR_NO_OP`<br>Possible values are `ROUTE_ATTR_NO_OP`, `ROUTE_ATTR_ADVERTISE`, `ROUTE_ATTR_INSTALL_HOST`, `ROUTE_ATTR_INSTALL_FORWARDING`, `ROUTE_ATTR_MERGE_ONLY`<br>[Enum: ROUTE_ATTR_NO_OP|ROUTE_ATTR_ADVERTISE|ROUTE_ATTR_INSTALL_HOST|ROUTE_ATTR_INSTALL_FORWARDING|ROUTE_ATTR_MERGE_ONLY] Attributes. List of attributes that control forwarding, dynamic routing and control plane (host) reachability
|
|
719
719
|
|
|
720
|
-
<a id="
|
|
720
|
+
<a id="gateway-24e6e5"></a>• [`default_gateway`](#gateway-24e6e5) - Optional Block<br>Enable this option
|
|
721
721
|
|
|
722
|
-
<a id="
|
|
722
|
+
<a id="address-19b3f8"></a>• [`ip_address`](#address-19b3f8) - Optional String<br>IP Address. Traffic matching the IP prefixes is sent to this IP Address
|
|
723
723
|
|
|
724
|
-
<a id="
|
|
724
|
+
<a id="prefixes-1cfe0e"></a>• [`ip_prefixes`](#prefixes-1cfe0e) - Optional List<br>IP Prefixes. List of route prefixes that have common next hop and attributes
|
|
725
725
|
|
|
726
|
-
<a id="
|
|
726
|
+
<a id="interface-f046b3"></a>• [`node_interface`](#interface-f046b3) - Optional Block<br>NodeInterfaceType. On multinode site, this type holds the information about per node interfaces<br>See [Node Interface](#interface-f046b3) below.
|
|
727
727
|
|
|
728
728
|
#### Custom Network Config SLI Config Static Routes Static Routes Node Interface
|
|
729
729
|
|
|
730
|
-
A [`node_interface`](#
|
|
730
|
+
A [`node_interface`](#interface-f046b3) block (within [`custom_network_config.sli_config.static_routes.static_routes`](#routes-75c512)) supports the following:
|
|
731
731
|
|
|
732
|
-
<a id="
|
|
732
|
+
<a id="list-38d66c"></a>• [`list`](#list-38d66c) - Optional Block<br>Node Interface Info. On a multinode site, this list holds the nodes and corresponding networking_interface<br>See [List](#list-38d66c) below.
|
|
733
733
|
|
|
734
734
|
#### Custom Network Config SLI Config Static Routes Static Routes Node Interface List
|
|
735
735
|
|
|
736
|
-
A [`list`](#
|
|
736
|
+
A [`list`](#list-38d66c) block (within [`custom_network_config.sli_config.static_routes.static_routes.node_interface`](#interface-f046b3)) supports the following:
|
|
737
737
|
|
|
738
|
-
<a id="
|
|
738
|
+
<a id="interface-8e37b4"></a>• [`interface`](#interface-8e37b4) - Optional Block<br>Interface. Interface reference on this node<br>See [Interface](#interface-8e37b4) below.
|
|
739
739
|
|
|
740
|
-
<a id="
|
|
740
|
+
<a id="node-d9a418"></a>• [`node`](#node-d9a418) - Optional String<br>Node. Node name on this site
|
|
741
741
|
|
|
742
742
|
#### Custom Network Config SLI Config Static Routes Static Routes Node Interface List Interface
|
|
743
743
|
|
|
744
|
-
An [`interface`](#
|
|
744
|
+
An [`interface`](#interface-8e37b4) block (within [`custom_network_config.sli_config.static_routes.static_routes.node_interface.list`](#list-38d66c)) supports the following:
|
|
745
745
|
|
|
746
|
-
<a id="
|
|
746
|
+
<a id="kind-623a25"></a>• [`kind`](#kind-623a25) - Optional String<br>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')
|
|
747
747
|
|
|
748
|
-
<a id="
|
|
748
|
+
<a id="name-52619d"></a>• [`name`](#name-52619d) - Optional String<br>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
|
|
749
749
|
|
|
750
|
-
<a id="
|
|
750
|
+
<a id="namespace-29f395"></a>• [`namespace`](#namespace-29f395) - Optional String<br>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
|
|
751
751
|
|
|
752
|
-
<a id="
|
|
752
|
+
<a id="tenant-9b8885"></a>• [`tenant`](#tenant-9b8885) - Optional String<br>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
|
|
753
753
|
|
|
754
|
-
<a id="
|
|
754
|
+
<a id="uid-37fee1"></a>• [`uid`](#uid-37fee1) - Optional String<br>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
|
|
755
755
|
|
|
756
756
|
#### Custom Network Config SLI Config Static V6 Routes
|
|
757
757
|
|
|
758
|
-
A [`static_v6_routes`](#
|
|
758
|
+
A [`static_v6_routes`](#routes-3c3781) block (within [`custom_network_config.sli_config`](#custom-network-config-sli-config)) supports the following:
|
|
759
759
|
|
|
760
|
-
<a id="
|
|
760
|
+
<a id="routes-a9d56b"></a>• [`static_routes`](#routes-a9d56b) - Optional Block<br>Static IPv6 Routes. List of IPv6 static routes<br>See [Static Routes](#routes-a9d56b) below.
|
|
761
761
|
|
|
762
762
|
#### Custom Network Config SLI Config Static V6 Routes Static Routes
|
|
763
763
|
|
|
764
|
-
A [`static_routes`](#
|
|
764
|
+
A [`static_routes`](#routes-a9d56b) block (within [`custom_network_config.sli_config.static_v6_routes`](#routes-3c3781)) supports the following:
|
|
765
765
|
|
|
766
|
-
<a id="
|
|
766
|
+
<a id="attrs-872d1e"></a>• [`attrs`](#attrs-872d1e) - Optional List Defaults to `ROUTE_ATTR_NO_OP`<br>Possible values are `ROUTE_ATTR_NO_OP`, `ROUTE_ATTR_ADVERTISE`, `ROUTE_ATTR_INSTALL_HOST`, `ROUTE_ATTR_INSTALL_FORWARDING`, `ROUTE_ATTR_MERGE_ONLY`<br>[Enum: ROUTE_ATTR_NO_OP|ROUTE_ATTR_ADVERTISE|ROUTE_ATTR_INSTALL_HOST|ROUTE_ATTR_INSTALL_FORWARDING|ROUTE_ATTR_MERGE_ONLY] Attributes. List of attributes that control forwarding, dynamic routing and control plane (host) reachability
|
|
767
767
|
|
|
768
|
-
<a id="
|
|
768
|
+
<a id="gateway-120546"></a>• [`default_gateway`](#gateway-120546) - Optional Block<br>Enable this option
|
|
769
769
|
|
|
770
|
-
<a id="
|
|
770
|
+
<a id="address-3f5f42"></a>• [`ip_address`](#address-3f5f42) - Optional String<br>IP Address. Traffic matching the IP prefixes is sent to this IP Address
|
|
771
771
|
|
|
772
|
-
<a id="
|
|
772
|
+
<a id="prefixes-4bb86e"></a>• [`ip_prefixes`](#prefixes-4bb86e) - Optional List<br>IPv6 Prefixes. List of IPv6 route prefixes that have common next hop and attributes
|
|
773
773
|
|
|
774
|
-
<a id="
|
|
774
|
+
<a id="interface-05123d"></a>• [`node_interface`](#interface-05123d) - Optional Block<br>NodeInterfaceType. On multinode site, this type holds the information about per node interfaces<br>See [Node Interface](#interface-05123d) below.
|
|
775
775
|
|
|
776
776
|
#### Custom Network Config SLI Config Static V6 Routes Static Routes Node Interface
|
|
777
777
|
|
|
778
|
-
A [`node_interface`](#
|
|
778
|
+
A [`node_interface`](#interface-05123d) block (within [`custom_network_config.sli_config.static_v6_routes.static_routes`](#routes-a9d56b)) supports the following:
|
|
779
779
|
|
|
780
|
-
<a id="
|
|
780
|
+
<a id="list-9abd74"></a>• [`list`](#list-9abd74) - Optional Block<br>Node Interface Info. On a multinode site, this list holds the nodes and corresponding networking_interface<br>See [List](#list-9abd74) below.
|
|
781
781
|
|
|
782
782
|
#### Custom Network Config SLI Config Static V6 Routes Static Routes Node Interface List
|
|
783
783
|
|
|
784
|
-
A [`list`](#
|
|
784
|
+
A [`list`](#list-9abd74) block (within [`custom_network_config.sli_config.static_v6_routes.static_routes.node_interface`](#interface-05123d)) supports the following:
|
|
785
785
|
|
|
786
|
-
<a id="
|
|
786
|
+
<a id="interface-a08aed"></a>• [`interface`](#interface-a08aed) - Optional Block<br>Interface. Interface reference on this node<br>See [Interface](#interface-a08aed) below.
|
|
787
787
|
|
|
788
|
-
<a id="
|
|
788
|
+
<a id="node-712c01"></a>• [`node`](#node-712c01) - Optional String<br>Node. Node name on this site
|
|
789
789
|
|
|
790
790
|
#### Custom Network Config SLI Config Static V6 Routes Static Routes Node Interface List Interface
|
|
791
791
|
|
|
792
|
-
An [`interface`](#
|
|
792
|
+
An [`interface`](#interface-a08aed) block (within [`custom_network_config.sli_config.static_v6_routes.static_routes.node_interface.list`](#list-9abd74)) supports the following:
|
|
793
793
|
|
|
794
|
-
<a id="
|
|
794
|
+
<a id="kind-2fd0e8"></a>• [`kind`](#kind-2fd0e8) - Optional String<br>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')
|
|
795
795
|
|
|
796
|
-
<a id="
|
|
796
|
+
<a id="name-63105d"></a>• [`name`](#name-63105d) - Optional String<br>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
|
|
797
797
|
|
|
798
|
-
<a id="
|
|
798
|
+
<a id="namespace-65007b"></a>• [`namespace`](#namespace-65007b) - Optional String<br>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
|
|
799
799
|
|
|
800
|
-
<a id="
|
|
800
|
+
<a id="tenant-60df32"></a>• [`tenant`](#tenant-60df32) - Optional String<br>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
|
|
801
801
|
|
|
802
|
-
<a id="
|
|
802
|
+
<a id="uid-78ff94"></a>• [`uid`](#uid-78ff94) - Optional String<br>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
|
|
803
803
|
|
|
804
804
|
#### Custom Network Config Slo Config
|
|
805
805
|
|
|
806
806
|
A [`slo_config`](#custom-network-config-slo-config) block (within [`custom_network_config`](#custom-network-config)) supports the following:
|
|
807
807
|
|
|
808
|
-
<a id="
|
|
808
|
+
<a id="group-4f2dd5"></a>• [`dc_cluster_group`](#group-4f2dd5) - Optional Block<br>Object reference. 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<br>See [Dc Cluster Group](#group-4f2dd5) below.
|
|
809
809
|
|
|
810
810
|
<a id="custom-network-config-slo-config-labels"></a>• [`labels`](#custom-network-config-slo-config-labels) - Optional Block<br>Network Labels. Add Labels for this network, these labels can be used in firewall policy
|
|
811
811
|
|
|
812
|
-
<a id="
|
|
812
|
+
<a id="group-babd4e"></a>• [`no_dc_cluster_group`](#group-babd4e) - Optional Block<br>Enable this option
|
|
813
813
|
|
|
814
|
-
<a id="
|
|
814
|
+
<a id="routes-9a2e74"></a>• [`no_static_routes`](#routes-9a2e74) - Optional Block<br>Enable this option
|
|
815
815
|
|
|
816
|
-
<a id="
|
|
816
|
+
<a id="routes-d536d3"></a>• [`no_static_v6_routes`](#routes-d536d3) - Optional Block<br>Enable this option
|
|
817
817
|
|
|
818
|
-
<a id="
|
|
818
|
+
<a id="routes-f61105"></a>• [`static_routes`](#routes-f61105) - Optional Block<br>Static Routes List. List of static routes<br>See [Static Routes](#routes-f61105) below.
|
|
819
819
|
|
|
820
|
-
<a id="
|
|
820
|
+
<a id="routes-c7512d"></a>• [`static_v6_routes`](#routes-c7512d) - Optional Block<br>Static IPv6 Routes List. List of IPv6 static routes<br>See [Static V6 Routes](#routes-c7512d) below.
|
|
821
821
|
|
|
822
822
|
#### Custom Network Config Slo Config Dc Cluster Group
|
|
823
823
|
|
|
824
|
-
A [`dc_cluster_group`](#
|
|
824
|
+
A [`dc_cluster_group`](#group-4f2dd5) block (within [`custom_network_config.slo_config`](#custom-network-config-slo-config)) supports the following:
|
|
825
825
|
|
|
826
|
-
<a id="
|
|
826
|
+
<a id="name-836469"></a>• [`name`](#name-836469) - Optional String<br>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
|
|
827
827
|
|
|
828
|
-
<a id="
|
|
828
|
+
<a id="namespace-f2a328"></a>• [`namespace`](#namespace-f2a328) - Optional String<br>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
|
|
829
829
|
|
|
830
|
-
<a id="
|
|
830
|
+
<a id="tenant-22eb05"></a>• [`tenant`](#tenant-22eb05) - Optional String<br>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
|
|
831
831
|
|
|
832
832
|
#### Custom Network Config Slo Config Static Routes
|
|
833
833
|
|
|
834
|
-
A [`static_routes`](#
|
|
834
|
+
A [`static_routes`](#routes-f61105) block (within [`custom_network_config.slo_config`](#custom-network-config-slo-config)) supports the following:
|
|
835
835
|
|
|
836
|
-
<a id="
|
|
836
|
+
<a id="routes-5ecd87"></a>• [`static_routes`](#routes-5ecd87) - Optional Block<br>Static Routes. List of static routes<br>See [Static Routes](#routes-5ecd87) below.
|
|
837
837
|
|
|
838
838
|
#### Custom Network Config Slo Config Static Routes Static Routes
|
|
839
839
|
|
|
840
|
-
A [`static_routes`](#
|
|
840
|
+
A [`static_routes`](#routes-5ecd87) block (within [`custom_network_config.slo_config.static_routes`](#routes-f61105)) supports the following:
|
|
841
841
|
|
|
842
|
-
<a id="
|
|
842
|
+
<a id="attrs-e54bc8"></a>• [`attrs`](#attrs-e54bc8) - Optional List Defaults to `ROUTE_ATTR_NO_OP`<br>Possible values are `ROUTE_ATTR_NO_OP`, `ROUTE_ATTR_ADVERTISE`, `ROUTE_ATTR_INSTALL_HOST`, `ROUTE_ATTR_INSTALL_FORWARDING`, `ROUTE_ATTR_MERGE_ONLY`<br>[Enum: ROUTE_ATTR_NO_OP|ROUTE_ATTR_ADVERTISE|ROUTE_ATTR_INSTALL_HOST|ROUTE_ATTR_INSTALL_FORWARDING|ROUTE_ATTR_MERGE_ONLY] Attributes. List of attributes that control forwarding, dynamic routing and control plane (host) reachability
|
|
843
843
|
|
|
844
|
-
<a id="
|
|
844
|
+
<a id="gateway-6d09e9"></a>• [`default_gateway`](#gateway-6d09e9) - Optional Block<br>Enable this option
|
|
845
845
|
|
|
846
|
-
<a id="
|
|
846
|
+
<a id="address-1260b8"></a>• [`ip_address`](#address-1260b8) - Optional String<br>IP Address. Traffic matching the IP prefixes is sent to this IP Address
|
|
847
847
|
|
|
848
|
-
<a id="
|
|
848
|
+
<a id="prefixes-ccce70"></a>• [`ip_prefixes`](#prefixes-ccce70) - Optional List<br>IP Prefixes. List of route prefixes that have common next hop and attributes
|
|
849
849
|
|
|
850
|
-
<a id="
|
|
850
|
+
<a id="interface-cb1ebb"></a>• [`node_interface`](#interface-cb1ebb) - Optional Block<br>NodeInterfaceType. On multinode site, this type holds the information about per node interfaces<br>See [Node Interface](#interface-cb1ebb) below.
|
|
851
851
|
|
|
852
852
|
#### Custom Network Config Slo Config Static Routes Static Routes Node Interface
|
|
853
853
|
|
|
854
|
-
A [`node_interface`](#
|
|
854
|
+
A [`node_interface`](#interface-cb1ebb) block (within [`custom_network_config.slo_config.static_routes.static_routes`](#routes-5ecd87)) supports the following:
|
|
855
855
|
|
|
856
|
-
<a id="
|
|
856
|
+
<a id="list-5e3b59"></a>• [`list`](#list-5e3b59) - Optional Block<br>Node Interface Info. On a multinode site, this list holds the nodes and corresponding networking_interface<br>See [List](#list-5e3b59) below.
|
|
857
857
|
|
|
858
858
|
#### Custom Network Config Slo Config Static Routes Static Routes Node Interface List
|
|
859
859
|
|
|
860
|
-
A [`list`](#
|
|
860
|
+
A [`list`](#list-5e3b59) block (within [`custom_network_config.slo_config.static_routes.static_routes.node_interface`](#interface-cb1ebb)) supports the following:
|
|
861
861
|
|
|
862
|
-
<a id="
|
|
862
|
+
<a id="interface-5e9576"></a>• [`interface`](#interface-5e9576) - Optional Block<br>Interface. Interface reference on this node<br>See [Interface](#interface-5e9576) below.
|
|
863
863
|
|
|
864
|
-
<a id="
|
|
864
|
+
<a id="node-0f772c"></a>• [`node`](#node-0f772c) - Optional String<br>Node. Node name on this site
|
|
865
865
|
|
|
866
866
|
#### Custom Network Config Slo Config Static Routes Static Routes Node Interface List Interface
|
|
867
867
|
|
|
868
|
-
An [`interface`](#
|
|
868
|
+
An [`interface`](#interface-5e9576) block (within [`custom_network_config.slo_config.static_routes.static_routes.node_interface.list`](#list-5e3b59)) supports the following:
|
|
869
869
|
|
|
870
|
-
<a id="
|
|
870
|
+
<a id="kind-366924"></a>• [`kind`](#kind-366924) - Optional String<br>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')
|
|
871
871
|
|
|
872
|
-
<a id="
|
|
872
|
+
<a id="name-16390b"></a>• [`name`](#name-16390b) - Optional String<br>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
|
|
873
873
|
|
|
874
|
-
<a id="
|
|
874
|
+
<a id="namespace-9e80d1"></a>• [`namespace`](#namespace-9e80d1) - Optional String<br>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
|
|
875
875
|
|
|
876
|
-
<a id="
|
|
876
|
+
<a id="tenant-8000b0"></a>• [`tenant`](#tenant-8000b0) - Optional String<br>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
|
|
877
877
|
|
|
878
|
-
<a id="
|
|
878
|
+
<a id="uid-324473"></a>• [`uid`](#uid-324473) - Optional String<br>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
|
|
879
879
|
|
|
880
880
|
#### Custom Network Config Slo Config Static V6 Routes
|
|
881
881
|
|
|
882
|
-
A [`static_v6_routes`](#
|
|
882
|
+
A [`static_v6_routes`](#routes-c7512d) block (within [`custom_network_config.slo_config`](#custom-network-config-slo-config)) supports the following:
|
|
883
883
|
|
|
884
|
-
<a id="
|
|
884
|
+
<a id="routes-77d696"></a>• [`static_routes`](#routes-77d696) - Optional Block<br>Static IPv6 Routes. List of IPv6 static routes<br>See [Static Routes](#routes-77d696) below.
|
|
885
885
|
|
|
886
886
|
#### Custom Network Config Slo Config Static V6 Routes Static Routes
|
|
887
887
|
|
|
888
|
-
A [`static_routes`](#
|
|
888
|
+
A [`static_routes`](#routes-77d696) block (within [`custom_network_config.slo_config.static_v6_routes`](#routes-c7512d)) supports the following:
|
|
889
889
|
|
|
890
|
-
<a id="
|
|
890
|
+
<a id="attrs-7c24b5"></a>• [`attrs`](#attrs-7c24b5) - Optional List Defaults to `ROUTE_ATTR_NO_OP`<br>Possible values are `ROUTE_ATTR_NO_OP`, `ROUTE_ATTR_ADVERTISE`, `ROUTE_ATTR_INSTALL_HOST`, `ROUTE_ATTR_INSTALL_FORWARDING`, `ROUTE_ATTR_MERGE_ONLY`<br>[Enum: ROUTE_ATTR_NO_OP|ROUTE_ATTR_ADVERTISE|ROUTE_ATTR_INSTALL_HOST|ROUTE_ATTR_INSTALL_FORWARDING|ROUTE_ATTR_MERGE_ONLY] Attributes. List of attributes that control forwarding, dynamic routing and control plane (host) reachability
|
|
891
891
|
|
|
892
|
-
<a id="
|
|
892
|
+
<a id="gateway-ef4884"></a>• [`default_gateway`](#gateway-ef4884) - Optional Block<br>Enable this option
|
|
893
893
|
|
|
894
|
-
<a id="
|
|
894
|
+
<a id="address-cd3411"></a>• [`ip_address`](#address-cd3411) - Optional String<br>IP Address. Traffic matching the IP prefixes is sent to this IP Address
|
|
895
895
|
|
|
896
|
-
<a id="
|
|
896
|
+
<a id="prefixes-1da29c"></a>• [`ip_prefixes`](#prefixes-1da29c) - Optional List<br>IPv6 Prefixes. List of IPv6 route prefixes that have common next hop and attributes
|
|
897
897
|
|
|
898
|
-
<a id="
|
|
898
|
+
<a id="interface-15c5a2"></a>• [`node_interface`](#interface-15c5a2) - Optional Block<br>NodeInterfaceType. On multinode site, this type holds the information about per node interfaces<br>See [Node Interface](#interface-15c5a2) below.
|
|
899
899
|
|
|
900
900
|
#### Custom Network Config Slo Config Static V6 Routes Static Routes Node Interface
|
|
901
901
|
|
|
902
|
-
A [`node_interface`](#
|
|
902
|
+
A [`node_interface`](#interface-15c5a2) block (within [`custom_network_config.slo_config.static_v6_routes.static_routes`](#routes-77d696)) supports the following:
|
|
903
903
|
|
|
904
|
-
<a id="
|
|
904
|
+
<a id="list-afdaaf"></a>• [`list`](#list-afdaaf) - Optional Block<br>Node Interface Info. On a multinode site, this list holds the nodes and corresponding networking_interface<br>See [List](#list-afdaaf) below.
|
|
905
905
|
|
|
906
906
|
#### Custom Network Config Slo Config Static V6 Routes Static Routes Node Interface List
|
|
907
907
|
|
|
908
|
-
A [`list`](#
|
|
908
|
+
A [`list`](#list-afdaaf) block (within [`custom_network_config.slo_config.static_v6_routes.static_routes.node_interface`](#interface-15c5a2)) supports the following:
|
|
909
909
|
|
|
910
|
-
<a id="
|
|
910
|
+
<a id="interface-752e77"></a>• [`interface`](#interface-752e77) - Optional Block<br>Interface. Interface reference on this node<br>See [Interface](#interface-752e77) below.
|
|
911
911
|
|
|
912
|
-
<a id="
|
|
912
|
+
<a id="node-3d5bdc"></a>• [`node`](#node-3d5bdc) - Optional String<br>Node. Node name on this site
|
|
913
913
|
|
|
914
914
|
#### Custom Network Config Slo Config Static V6 Routes Static Routes Node Interface List Interface
|
|
915
915
|
|
|
916
|
-
An [`interface`](#
|
|
916
|
+
An [`interface`](#interface-752e77) block (within [`custom_network_config.slo_config.static_v6_routes.static_routes.node_interface.list`](#list-afdaaf)) supports the following:
|
|
917
917
|
|
|
918
|
-
<a id="
|
|
918
|
+
<a id="kind-2102df"></a>• [`kind`](#kind-2102df) - Optional String<br>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')
|
|
919
919
|
|
|
920
|
-
<a id="
|
|
920
|
+
<a id="name-19e72d"></a>• [`name`](#name-19e72d) - Optional String<br>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
|
|
921
921
|
|
|
922
|
-
<a id="
|
|
922
|
+
<a id="namespace-fb792d"></a>• [`namespace`](#namespace-fb792d) - Optional String<br>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
|
|
923
923
|
|
|
924
|
-
<a id="
|
|
924
|
+
<a id="tenant-0f27f2"></a>• [`tenant`](#tenant-0f27f2) - Optional String<br>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
|
|
925
925
|
|
|
926
|
-
<a id="
|
|
926
|
+
<a id="uid-522654"></a>• [`uid`](#uid-522654) - Optional String<br>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
|
|
927
927
|
|
|
928
928
|
#### Custom Storage Config
|
|
929
929
|
|
|
930
930
|
A [`custom_storage_config`](#custom-storage-config) block supports the following:
|
|
931
931
|
|
|
932
|
-
<a id="
|
|
932
|
+
<a id="class-8a4650"></a>• [`default_storage_class`](#class-8a4650) - Optional Block<br>Enable this option
|
|
933
933
|
|
|
934
934
|
<a id="custom-storage-config-no-static-routes"></a>• [`no_static_routes`](#custom-storage-config-no-static-routes) - Optional Block<br>Enable this option
|
|
935
935
|
|
|
936
936
|
<a id="custom-storage-config-no-storage-device"></a>• [`no_storage_device`](#custom-storage-config-no-storage-device) - Optional Block<br>Enable this option
|
|
937
937
|
|
|
938
|
-
<a id="
|
|
938
|
+
<a id="interfaces-a4a448"></a>• [`no_storage_interfaces`](#interfaces-a4a448) - Optional Block<br>Enable this option
|
|
939
939
|
|
|
940
940
|
<a id="custom-storage-config-static-routes"></a>• [`static_routes`](#custom-storage-config-static-routes) - Optional Block<br>Static Routes List. List of static routes<br>See [Static Routes](#custom-storage-config-static-routes) below.
|
|
941
941
|
|
|
942
|
-
<a id="
|
|
942
|
+
<a id="list-268762"></a>• [`storage_class_list`](#list-268762) - Optional Block<br>Custom Storage Class List. Add additional custom storage classes in kubernetes for this fleet<br>See [Storage Class List](#list-268762) below.
|
|
943
943
|
|
|
944
|
-
<a id="
|
|
944
|
+
<a id="list-650498"></a>• [`storage_device_list`](#list-650498) - Optional Block<br>Custom Storage Device List. Add additional custom storage classes in kubernetes for this fleet<br>See [Storage Device List](#list-650498) below.
|
|
945
945
|
|
|
946
|
-
<a id="
|
|
946
|
+
<a id="list-c6bbef"></a>• [`storage_interface_list`](#list-c6bbef) - Optional Block<br>List of Interface. Configure storage interfaces for this App Stack site<br>See [Storage Interface List](#list-c6bbef) below.
|
|
947
947
|
|
|
948
948
|
#### Custom Storage Config Static Routes
|
|
949
949
|
|
|
950
950
|
A [`static_routes`](#custom-storage-config-static-routes) block (within [`custom_storage_config`](#custom-storage-config)) supports the following:
|
|
951
951
|
|
|
952
|
-
<a id="
|
|
952
|
+
<a id="routes-38e4c5"></a>• [`static_routes`](#routes-38e4c5) - Optional Block<br>Static Routes. List of static routes<br>See [Static Routes](#routes-38e4c5) below.
|
|
953
953
|
|
|
954
954
|
#### Custom Storage Config Static Routes Static Routes
|
|
955
955
|
|
|
956
|
-
A [`static_routes`](#
|
|
956
|
+
A [`static_routes`](#routes-38e4c5) block (within [`custom_storage_config.static_routes`](#custom-storage-config-static-routes)) supports the following:
|
|
957
957
|
|
|
958
|
-
<a id="
|
|
958
|
+
<a id="attrs-017f7f"></a>• [`attrs`](#attrs-017f7f) - Optional List Defaults to `ROUTE_ATTR_NO_OP`<br>Possible values are `ROUTE_ATTR_NO_OP`, `ROUTE_ATTR_ADVERTISE`, `ROUTE_ATTR_INSTALL_HOST`, `ROUTE_ATTR_INSTALL_FORWARDING`, `ROUTE_ATTR_MERGE_ONLY`<br>[Enum: ROUTE_ATTR_NO_OP|ROUTE_ATTR_ADVERTISE|ROUTE_ATTR_INSTALL_HOST|ROUTE_ATTR_INSTALL_FORWARDING|ROUTE_ATTR_MERGE_ONLY] Attributes. List of attributes that control forwarding, dynamic routing and control plane (host) reachability
|
|
959
959
|
|
|
960
|
-
<a id="
|
|
960
|
+
<a id="gateway-64b546"></a>• [`default_gateway`](#gateway-64b546) - Optional Block<br>Enable this option
|
|
961
961
|
|
|
962
|
-
<a id="
|
|
962
|
+
<a id="address-3bde3d"></a>• [`ip_address`](#address-3bde3d) - Optional String<br>IP Address. Traffic matching the IP prefixes is sent to this IP Address
|
|
963
963
|
|
|
964
|
-
<a id="
|
|
964
|
+
<a id="prefixes-277476"></a>• [`ip_prefixes`](#prefixes-277476) - Optional List<br>IP Prefixes. List of route prefixes that have common next hop and attributes
|
|
965
965
|
|
|
966
|
-
<a id="
|
|
966
|
+
<a id="interface-9c7667"></a>• [`node_interface`](#interface-9c7667) - Optional Block<br>NodeInterfaceType. On multinode site, this type holds the information about per node interfaces<br>See [Node Interface](#interface-9c7667) below.
|
|
967
967
|
|
|
968
968
|
#### Custom Storage Config Static Routes Static Routes Node Interface
|
|
969
969
|
|
|
970
|
-
A [`node_interface`](#
|
|
970
|
+
A [`node_interface`](#interface-9c7667) block (within [`custom_storage_config.static_routes.static_routes`](#routes-38e4c5)) supports the following:
|
|
971
971
|
|
|
972
|
-
<a id="
|
|
972
|
+
<a id="list-d08831"></a>• [`list`](#list-d08831) - Optional Block<br>Node Interface Info. On a multinode site, this list holds the nodes and corresponding networking_interface<br>See [List](#list-d08831) below.
|
|
973
973
|
|
|
974
974
|
#### Custom Storage Config Static Routes Static Routes Node Interface List
|
|
975
975
|
|
|
976
|
-
A [`list`](#
|
|
976
|
+
A [`list`](#list-d08831) block (within [`custom_storage_config.static_routes.static_routes.node_interface`](#interface-9c7667)) supports the following:
|
|
977
977
|
|
|
978
|
-
<a id="
|
|
978
|
+
<a id="interface-6bb98d"></a>• [`interface`](#interface-6bb98d) - Optional Block<br>Interface. Interface reference on this node<br>See [Interface](#interface-6bb98d) below.
|
|
979
979
|
|
|
980
|
-
<a id="
|
|
980
|
+
<a id="node-a156da"></a>• [`node`](#node-a156da) - Optional String<br>Node. Node name on this site
|
|
981
981
|
|
|
982
982
|
#### Custom Storage Config Static Routes Static Routes Node Interface List Interface
|
|
983
983
|
|
|
984
|
-
An [`interface`](#
|
|
984
|
+
An [`interface`](#interface-6bb98d) block (within [`custom_storage_config.static_routes.static_routes.node_interface.list`](#list-d08831)) supports the following:
|
|
985
985
|
|
|
986
|
-
<a id="
|
|
986
|
+
<a id="kind-daef83"></a>• [`kind`](#kind-daef83) - Optional String<br>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')
|
|
987
987
|
|
|
988
|
-
<a id="
|
|
988
|
+
<a id="name-fd2e4d"></a>• [`name`](#name-fd2e4d) - Optional String<br>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
|
|
989
989
|
|
|
990
|
-
<a id="
|
|
990
|
+
<a id="namespace-a4e3e3"></a>• [`namespace`](#namespace-a4e3e3) - Optional String<br>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
|
|
991
991
|
|
|
992
|
-
<a id="
|
|
992
|
+
<a id="tenant-50869f"></a>• [`tenant`](#tenant-50869f) - Optional String<br>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
|
|
993
993
|
|
|
994
|
-
<a id="
|
|
994
|
+
<a id="uid-54eaba"></a>• [`uid`](#uid-54eaba) - Optional String<br>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
|
|
995
995
|
|
|
996
996
|
#### Custom Storage Config Storage Class List
|
|
997
997
|
|
|
998
|
-
A [`storage_class_list`](#
|
|
998
|
+
A [`storage_class_list`](#list-268762) block (within [`custom_storage_config`](#custom-storage-config)) supports the following:
|
|
999
999
|
|
|
1000
|
-
<a id="
|
|
1000
|
+
<a id="classes-b5444a"></a>• [`storage_classes`](#classes-b5444a) - Optional Block<br>List of Storage Classes. List of custom storage classes<br>See [Storage Classes](#classes-b5444a) below.
|
|
1001
1001
|
|
|
1002
1002
|
#### Custom Storage Config Storage Class List Storage Classes
|
|
1003
1003
|
|
|
1004
|
-
A [`storage_classes`](#
|
|
1004
|
+
A [`storage_classes`](#classes-b5444a) block (within [`custom_storage_config.storage_class_list`](#list-268762)) supports the following:
|
|
1005
1005
|
|
|
1006
|
-
<a id="
|
|
1006
|
+
<a id="parameters-ca466a"></a>• [`advanced_storage_parameters`](#parameters-ca466a) - Optional Block<br>Advanced Parameters. Map of parameter name and string value
|
|
1007
1007
|
|
|
1008
|
-
<a id="
|
|
1008
|
+
<a id="expansion-17bdb9"></a>• [`allow_volume_expansion`](#expansion-17bdb9) - Optional Bool<br>Allow Volume Expansion. Allow volume expansion
|
|
1009
1009
|
|
|
1010
|
-
<a id="
|
|
1010
|
+
<a id="storage-d7c70e"></a>• [`custom_storage`](#storage-d7c70e) - Optional Block<br>Custom StorageClass. Custom Storage Class allows to insert Kubernetes storageclass definition which will be applied into given site<br>See [Custom Storage](#storage-d7c70e) below.
|
|
1011
1011
|
|
|
1012
|
-
<a id="
|
|
1012
|
+
<a id="class-6ee8ed"></a>• [`default_storage_class`](#class-6ee8ed) - Optional Bool<br>Default Storage Class. Make this storage class default storage class for the K8S cluster
|
|
1013
1013
|
|
|
1014
|
-
<a id="
|
|
1014
|
+
<a id="spec-7db866"></a>• [`description_spec`](#spec-7db866) - Optional String<br>Storage Class Description. Description for this storage class
|
|
1015
1015
|
|
|
1016
|
-
<a id="
|
|
1016
|
+
<a id="storage-df442c"></a>• [`hpe_storage`](#storage-df442c) - Optional Block<br>HPE Storage. Storage class Device configuration for HPE Storage<br>See [Hpe Storage](#storage-df442c) below.
|
|
1017
1017
|
|
|
1018
|
-
<a id="
|
|
1018
|
+
<a id="trident-23dac6"></a>• [`netapp_trident`](#trident-23dac6) - Optional Block<br>NetApp Trident Storage. Storage class Device configuration for NetApp Trident<br>See [Netapp Trident](#trident-23dac6) below.
|
|
1019
1019
|
|
|
1020
|
-
<a id="
|
|
1020
|
+
<a id="orchestrator-f833eb"></a>• [`pure_service_orchestrator`](#orchestrator-f833eb) - Optional Block<br>Pure Storage Service Orchestrator. Storage class Device configuration for Pure Service Orchestrator<br>See [Pure Service Orchestrator](#orchestrator-f833eb) below.
|
|
1021
1021
|
|
|
1022
|
-
<a id="
|
|
1022
|
+
<a id="policy-892865"></a>• [`reclaim_policy`](#policy-892865) - Optional String<br>Reclaim Policy. Reclaim Policy
|
|
1023
1023
|
|
|
1024
|
-
<a id="
|
|
1024
|
+
<a id="name-e57bab"></a>• [`storage_class_name`](#name-e57bab) - Optional String<br>Storage Class Name. Name of the storage class as it will appear in K8S
|
|
1025
1025
|
|
|
1026
|
-
<a id="
|
|
1026
|
+
<a id="device-aebdea"></a>• [`storage_device`](#device-aebdea) - Optional String<br>Storage Device. Storage device that this class will use. The Device name defined at previous step
|
|
1027
1027
|
|
|
1028
1028
|
#### Custom Storage Config Storage Class List Storage Classes Custom Storage
|
|
1029
1029
|
|
|
1030
|
-
A [`custom_storage`](#
|
|
1030
|
+
A [`custom_storage`](#storage-d7c70e) block (within [`custom_storage_config.storage_class_list.storage_classes`](#classes-b5444a)) supports the following:
|
|
1031
1031
|
|
|
1032
|
-
<a id="
|
|
1032
|
+
<a id="yaml-f58bc4"></a>• [`yaml`](#yaml-f58bc4) - Optional String<br>Storage Class YAML. K8S YAML for StorageClass
|
|
1033
1033
|
|
|
1034
1034
|
#### Custom Storage Config Storage Class List Storage Classes Hpe Storage
|
|
1035
1035
|
|
|
1036
|
-
A [`hpe_storage`](#
|
|
1036
|
+
A [`hpe_storage`](#storage-df442c) block (within [`custom_storage_config.storage_class_list.storage_classes`](#classes-b5444a)) supports the following:
|
|
1037
1037
|
|
|
1038
|
-
<a id="
|
|
1038
|
+
<a id="mutations-0a8410"></a>• [`allow_mutations`](#mutations-0a8410) - Optional String<br>allowMutations. mutation can override specified parameters
|
|
1039
1039
|
|
|
1040
|
-
<a id="
|
|
1040
|
+
<a id="overrides-edff7f"></a>• [`allow_overrides`](#overrides-edff7f) - Optional String<br>allowOverrides. PVC can override specified parameters
|
|
1041
1041
|
|
|
1042
|
-
<a id="
|
|
1042
|
+
<a id="enabled-e6199e"></a>• [`dedupe_enabled`](#enabled-e6199e) - Optional Bool<br>dedupeEnabled. Indicates that the volume should enable deduplication
|
|
1043
1043
|
|
|
1044
|
-
<a id="
|
|
1044
|
+
<a id="spec-c82b66"></a>• [`description_spec`](#spec-c82b66) - Optional String<br>Description. The SecretName parameter is used to identify name of secret to identify backend storage's auth information
|
|
1045
1045
|
|
|
1046
|
-
<a id="
|
|
1046
|
+
<a id="delete-4e2a57"></a>• [`destroy_on_delete`](#delete-4e2a57) - Optional Bool<br>destroyOnDelete. Indicates the backing Nimble volume (including snapshots) should be destroyed when the PVC is deleted
|
|
1047
1047
|
|
|
1048
|
-
<a id="
|
|
1048
|
+
<a id="encrypted-80fb35"></a>• [`encrypted`](#encrypted-80fb35) - Optional Bool<br>encrypted. Indicates that the volume should be encrypted
|
|
1049
1049
|
|
|
1050
|
-
<a id="
|
|
1050
|
+
<a id="folder-a2de95"></a>• [`folder`](#folder-a2de95) - Optional String<br>folder. The name of the folder in which to place the volume
|
|
1051
1051
|
|
|
1052
|
-
<a id="
|
|
1052
|
+
<a id="iops-c850b4"></a>• [`limit_iops`](#iops-c850b4) - Optional String<br>limitIops. The IOPS limit of the volume
|
|
1053
1053
|
|
|
1054
|
-
<a id="
|
|
1054
|
+
<a id="mbps-dec8a3"></a>• [`limit_mbps`](#mbps-dec8a3) - Optional String<br>limitMbps. The IOPS limit of the volume
|
|
1055
1055
|
|
|
1056
|
-
<a id="
|
|
1056
|
+
<a id="policy-e1fbfe"></a>• [`performance_policy`](#policy-e1fbfe) - Optional String<br>performancePolicy. The name of the performance policy to assign to the volume
|
|
1057
1057
|
|
|
1058
|
-
<a id="
|
|
1058
|
+
<a id="pool-3db89a"></a>• [`pool`](#pool-3db89a) - Optional String<br>pool. The name of the pool in which to place the volume
|
|
1059
1059
|
|
|
1060
|
-
<a id="
|
|
1060
|
+
<a id="template-09527b"></a>• [`protection_template`](#template-09527b) - Optional String<br>protectionTemplate. The name of the performance policy to assign to the volume
|
|
1061
1061
|
|
|
1062
|
-
<a id="
|
|
1062
|
+
<a id="name-da8962"></a>• [`secret_name`](#name-da8962) - Optional String<br>Secret Name. The SecretName parameter is used to identify name of secret to identify backend storage's auth information
|
|
1063
1063
|
|
|
1064
|
-
<a id="
|
|
1064
|
+
<a id="namespace-1c2e4c"></a>• [`secret_namespace`](#namespace-1c2e4c) - Optional String<br>Secret Namespace. The SecretNamespace parameter is used to identify name of namespace where secret resides
|
|
1065
1065
|
|
|
1066
|
-
<a id="
|
|
1066
|
+
<a id="detach-049070"></a>• [`sync_on_detach`](#detach-049070) - Optional Bool<br>syncOnDetach. Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node
|
|
1067
1067
|
|
|
1068
|
-
<a id="
|
|
1068
|
+
<a id="thick-4ef756"></a>• [`thick`](#thick-4ef756) - Optional Bool<br>thick. Indicates that the volume should be thick provisioned
|
|
1069
1069
|
|
|
1070
1070
|
#### Custom Storage Config Storage Class List Storage Classes Netapp Trident
|
|
1071
1071
|
|
|
1072
|
-
A [`netapp_trident`](#
|
|
1072
|
+
A [`netapp_trident`](#trident-23dac6) block (within [`custom_storage_config.storage_class_list.storage_classes`](#classes-b5444a)) supports the following:
|
|
1073
1073
|
|
|
1074
|
-
<a id="
|
|
1074
|
+
<a id="selector-b252fb"></a>• [`selector`](#selector-b252fb) - Optional Block<br>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
|
|
1075
1075
|
|
|
1076
|
-
<a id="
|
|
1076
|
+
<a id="pools-5a9a45"></a>• [`storage_pools`](#pools-5a9a45) - Optional String<br>Storage Pools. The storagePools parameter is used to further restrict the set of pools that match any specified attributes
|
|
1077
1077
|
|
|
1078
1078
|
#### Custom Storage Config Storage Class List Storage Classes Pure Service Orchestrator
|
|
1079
1079
|
|
|
1080
|
-
A [`pure_service_orchestrator`](#
|
|
1080
|
+
A [`pure_service_orchestrator`](#orchestrator-f833eb) block (within [`custom_storage_config.storage_class_list.storage_classes`](#classes-b5444a)) supports the following:
|
|
1081
1081
|
|
|
1082
|
-
<a id="
|
|
1082
|
+
<a id="backend-47f142"></a>• [`backend`](#backend-47f142) - Optional String<br>Backend. Defines type of Pure storage backend block or file. The volume will have the aspects defined in the chosen virtual pool
|
|
1083
1083
|
|
|
1084
|
-
<a id="
|
|
1084
|
+
<a id="limit-5ac131"></a>• [`bandwidth_limit`](#limit-5ac131) - Optional String<br>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
|
|
1085
1085
|
|
|
1086
|
-
<a id="
|
|
1086
|
+
<a id="limit-239a56"></a>• [`iops_limit`](#limit-239a56) - Optional Number<br>IOPS Limit. Enable IOPS limitation. It must be between 100 and 100 million. If value is 0, IOPS limit is not defined
|
|
1087
1087
|
|
|
1088
1088
|
#### Custom Storage Config Storage Device List
|
|
1089
1089
|
|
|
1090
|
-
A [`storage_device_list`](#
|
|
1090
|
+
A [`storage_device_list`](#list-650498) block (within [`custom_storage_config`](#custom-storage-config)) supports the following:
|
|
1091
1091
|
|
|
1092
|
-
<a id="
|
|
1092
|
+
<a id="devices-0c06af"></a>• [`storage_devices`](#devices-0c06af) - Optional Block<br>List of Storage Devices. List of custom storage devices<br>See [Storage Devices](#devices-0c06af) below.
|
|
1093
1093
|
|
|
1094
1094
|
#### Custom Storage Config Storage Device List Storage Devices
|
|
1095
1095
|
|
|
1096
|
-
A [`storage_devices`](#
|
|
1096
|
+
A [`storage_devices`](#devices-0c06af) block (within [`custom_storage_config.storage_device_list`](#list-650498)) supports the following:
|
|
1097
1097
|
|
|
1098
|
-
<a id="
|
|
1098
|
+
<a id="parameters-8ee715"></a>• [`advanced_advanced_parameters`](#parameters-8ee715) - Optional Block<br>Advanced Parameters. Map of parameter name and string value
|
|
1099
1099
|
|
|
1100
|
-
<a id="
|
|
1100
|
+
<a id="storage-e57f7d"></a>• [`custom_storage`](#storage-e57f7d) - Optional Block<br>Enable this option
|
|
1101
1101
|
|
|
1102
|
-
<a id="
|
|
1102
|
+
<a id="storage-e99559"></a>• [`hpe_storage`](#storage-e99559) - Optional Block<br>HPE Storage. Device configuration for HPE Storage<br>See [Hpe Storage](#storage-e99559) below.
|
|
1103
1103
|
|
|
1104
|
-
<a id="
|
|
1104
|
+
<a id="trident-979b89"></a>• [`netapp_trident`](#trident-979b89) - Optional Block<br>NetApp Trident. Device configuration for NetApp Trident Storage<br>See [Netapp Trident](#trident-979b89) below.
|
|
1105
1105
|
|
|
1106
|
-
<a id="
|
|
1106
|
+
<a id="orchestrator-2f7da0"></a>• [`pure_service_orchestrator`](#orchestrator-2f7da0) - Optional Block<br>Pure Storage Service Orchestrator. Device configuration for Pure Storage Service Orchestrator<br>See [Pure Service Orchestrator](#orchestrator-2f7da0) below.
|
|
1107
1107
|
|
|
1108
|
-
<a id="
|
|
1108
|
+
<a id="device-bcf87a"></a>• [`storage_device`](#device-bcf87a) - Optional String<br>Storage Device. Storage device and device unit
|
|
1109
1109
|
|
|
1110
1110
|
#### Custom Storage Config Storage Device List Storage Devices Hpe Storage
|
|
1111
1111
|
|
|
1112
|
-
A [`hpe_storage`](#
|
|
1112
|
+
A [`hpe_storage`](#storage-e99559) block (within [`custom_storage_config.storage_device_list.storage_devices`](#devices-0c06af)) supports the following:
|
|
1113
1113
|
|
|
1114
|
-
<a id="
|
|
1114
|
+
<a id="port-9b5e60"></a>• [`api_server_port`](#port-9b5e60) - Optional Number<br>Storage server Port. Enter Storage Server Port
|
|
1115
1115
|
|
|
1116
|
-
<a id="
|
|
1116
|
+
<a id="password-b52a3f"></a>• [`iscsi_chap_password`](#password-b52a3f) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [iSCSI Chap Password](#password-b52a3f) below.
|
|
1117
1117
|
|
|
1118
|
-
<a id="
|
|
1118
|
+
<a id="user-88c15c"></a>• [`iscsi_chap_user`](#user-88c15c) - Optional String<br>iSCSI chapUser. chap Username to connect to the HPE storage
|
|
1119
1119
|
|
|
1120
|
-
<a id="
|
|
1120
|
+
<a id="password-fa8fb6"></a>• [`password`](#password-fa8fb6) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#password-fa8fb6) below.
|
|
1121
1121
|
|
|
1122
|
-
<a id="
|
|
1122
|
+
<a id="address-72ba57"></a>• [`storage_server_ip_address`](#address-72ba57) - Optional String<br>Storage Server IP address. Enter storage server IP address
|
|
1123
1123
|
|
|
1124
|
-
<a id="
|
|
1124
|
+
<a id="name-39ad6e"></a>• [`storage_server_name`](#name-39ad6e) - Optional String<br>Storage Server Name. Enter storage server Name
|
|
1125
1125
|
|
|
1126
|
-
<a id="
|
|
1126
|
+
<a id="username-238eba"></a>• [`username`](#username-238eba) - Optional String<br>Username. Username to connect to the HPE storage management IP
|
|
1127
1127
|
|
|
1128
1128
|
#### Custom Storage Config Storage Device List Storage Devices Hpe Storage iSCSI Chap Password
|
|
1129
1129
|
|
|
1130
|
-
An [`iscsi_chap_password`](#
|
|
1130
|
+
An [`iscsi_chap_password`](#password-b52a3f) block (within [`custom_storage_config.storage_device_list.storage_devices.hpe_storage`](#storage-e99559)) supports the following:
|
|
1131
1131
|
|
|
1132
|
-
<a id="
|
|
1132
|
+
<a id="info-a63803"></a>• [`blindfold_secret_info`](#info-a63803) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-a63803) below.
|
|
1133
1133
|
|
|
1134
|
-
<a id="
|
|
1134
|
+
<a id="info-181c69"></a>• [`clear_secret_info`](#info-181c69) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-181c69) below.
|
|
1135
1135
|
|
|
1136
1136
|
#### Custom Storage Config Storage Device List Storage Devices Hpe Storage iSCSI Chap Password Blindfold Secret Info
|
|
1137
1137
|
|
|
1138
|
-
A [`blindfold_secret_info`](#
|
|
1138
|
+
A [`blindfold_secret_info`](#info-a63803) block (within [`custom_storage_config.storage_device_list.storage_devices.hpe_storage.iscsi_chap_password`](#password-b52a3f)) supports the following:
|
|
1139
1139
|
|
|
1140
|
-
<a id="
|
|
1140
|
+
<a id="provider-ad2d4a"></a>• [`decryption_provider`](#provider-ad2d4a) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1141
1141
|
|
|
1142
|
-
<a id="
|
|
1142
|
+
<a id="location-09526a"></a>• [`location`](#location-09526a) - Optional String<br>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
|
|
1143
1143
|
|
|
1144
|
-
<a id="
|
|
1144
|
+
<a id="provider-89ddf9"></a>• [`store_provider`](#provider-89ddf9) - Optional String<br>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:///
|
|
1145
1145
|
|
|
1146
1146
|
#### Custom Storage Config Storage Device List Storage Devices Hpe Storage iSCSI Chap Password Clear Secret Info
|
|
1147
1147
|
|
|
1148
|
-
A [`clear_secret_info`](#
|
|
1148
|
+
A [`clear_secret_info`](#info-181c69) block (within [`custom_storage_config.storage_device_list.storage_devices.hpe_storage.iscsi_chap_password`](#password-b52a3f)) supports the following:
|
|
1149
1149
|
|
|
1150
|
-
<a id="
|
|
1150
|
+
<a id="ref-9a2910"></a>• [`provider_ref`](#ref-9a2910) - Optional String<br>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:///
|
|
1151
1151
|
|
|
1152
|
-
<a id="
|
|
1152
|
+
<a id="url-1f12d3"></a>• [`url`](#url-1f12d3) - Optional String<br>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
|
|
1153
1153
|
|
|
1154
1154
|
#### Custom Storage Config Storage Device List Storage Devices Hpe Storage Password
|
|
1155
1155
|
|
|
1156
|
-
A [`password`](#
|
|
1156
|
+
A [`password`](#password-fa8fb6) block (within [`custom_storage_config.storage_device_list.storage_devices.hpe_storage`](#storage-e99559)) supports the following:
|
|
1157
1157
|
|
|
1158
|
-
<a id="
|
|
1158
|
+
<a id="info-ae23b6"></a>• [`blindfold_secret_info`](#info-ae23b6) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-ae23b6) below.
|
|
1159
1159
|
|
|
1160
|
-
<a id="
|
|
1160
|
+
<a id="info-e6fbee"></a>• [`clear_secret_info`](#info-e6fbee) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-e6fbee) below.
|
|
1161
1161
|
|
|
1162
1162
|
#### Custom Storage Config Storage Device List Storage Devices Hpe Storage Password Blindfold Secret Info
|
|
1163
1163
|
|
|
1164
|
-
A [`blindfold_secret_info`](#
|
|
1164
|
+
A [`blindfold_secret_info`](#info-ae23b6) block (within [`custom_storage_config.storage_device_list.storage_devices.hpe_storage.password`](#password-fa8fb6)) supports the following:
|
|
1165
1165
|
|
|
1166
|
-
<a id="
|
|
1166
|
+
<a id="provider-8257ea"></a>• [`decryption_provider`](#provider-8257ea) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1167
1167
|
|
|
1168
|
-
<a id="
|
|
1168
|
+
<a id="location-c073e0"></a>• [`location`](#location-c073e0) - Optional String<br>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
|
|
1169
1169
|
|
|
1170
|
-
<a id="
|
|
1170
|
+
<a id="provider-ae7fc2"></a>• [`store_provider`](#provider-ae7fc2) - Optional String<br>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:///
|
|
1171
1171
|
|
|
1172
1172
|
#### Custom Storage Config Storage Device List Storage Devices Hpe Storage Password Clear Secret Info
|
|
1173
1173
|
|
|
1174
|
-
A [`clear_secret_info`](#
|
|
1174
|
+
A [`clear_secret_info`](#info-e6fbee) block (within [`custom_storage_config.storage_device_list.storage_devices.hpe_storage.password`](#password-fa8fb6)) supports the following:
|
|
1175
1175
|
|
|
1176
|
-
<a id="
|
|
1176
|
+
<a id="ref-070f7c"></a>• [`provider_ref`](#ref-070f7c) - Optional String<br>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:///
|
|
1177
1177
|
|
|
1178
|
-
<a id="
|
|
1178
|
+
<a id="url-2f4d88"></a>• [`url`](#url-2f4d88) - Optional String<br>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
|
|
1179
1179
|
|
|
1180
1180
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident
|
|
1181
1181
|
|
|
1182
|
-
A [`netapp_trident`](#
|
|
1182
|
+
A [`netapp_trident`](#trident-979b89) block (within [`custom_storage_config.storage_device_list.storage_devices`](#devices-0c06af)) supports the following:
|
|
1183
1183
|
|
|
1184
|
-
<a id="
|
|
1184
|
+
<a id="nas-ee38b4"></a>• [`netapp_backend_ontap_nas`](#nas-ee38b4) - Optional Block<br>Storage Backend NetApp ONTAP NAS. Configuration of storage backend for NetApp ONTAP NAS<br>See [Netapp Backend Ontap Nas](#nas-ee38b4) below.
|
|
1185
1185
|
|
|
1186
|
-
<a id="
|
|
1186
|
+
<a id="san-00fbe7"></a>• [`netapp_backend_ontap_san`](#san-00fbe7) - Optional Block<br>Storage Backend NetApp ONTAP SAN. Configuration of storage backend for NetApp ONTAP SAN<br>See [Netapp Backend Ontap San](#san-00fbe7) below.
|
|
1187
1187
|
|
|
1188
1188
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas
|
|
1189
1189
|
|
|
1190
|
-
A [`netapp_backend_ontap_nas`](#
|
|
1190
|
+
A [`netapp_backend_ontap_nas`](#nas-ee38b4) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident`](#trident-979b89)) supports the following:
|
|
1191
1191
|
|
|
1192
|
-
<a id="
|
|
1192
|
+
<a id="cidrs-af1113"></a>• [`auto_export_cidrs`](#cidrs-af1113) - Optional Block<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint<br>See [Auto Export Cidrs](#cidrs-af1113) below.
|
|
1193
1193
|
|
|
1194
|
-
<a id="
|
|
1194
|
+
<a id="policy-57dd22"></a>• [`auto_export_policy`](#policy-57dd22) - Optional Bool<br>Auto Export Policy. Enable automatic export policy creation and updating
|
|
1195
1195
|
|
|
1196
|
-
<a id="
|
|
1196
|
+
<a id="name-53df7b"></a>• [`backend_name`](#name-53df7b) - Optional String<br>Storage Backend Name. Configuration of Backend Name. Driver is name + '_' + dataLIF
|
|
1197
1197
|
|
|
1198
|
-
<a id="
|
|
1198
|
+
<a id="certificate-e405a6"></a>• [`client_certificate`](#certificate-e405a6) - Optional String<br>Client Certificate. Please Enter Base64-encoded value of client certificate. Used for certificate-based auth
|
|
1199
1199
|
|
|
1200
|
-
<a id="
|
|
1200
|
+
<a id="key-d50914"></a>• [`client_private_key`](#key-d50914) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Client Private Key](#key-d50914) below.
|
|
1201
1201
|
|
|
1202
|
-
<a id="
|
|
1202
|
+
<a id="name-0aa785"></a>• [`data_lif_dns_name`](#name-0aa785) - Optional String<br>Backend Data LIF Name. Backend Data LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name
|
|
1203
1203
|
|
|
1204
|
-
<a id="
|
|
1204
|
+
<a id="lif-ip-a86216"></a>• [`data_lif_ip`](#lif-ip-a86216) - Optional String<br>Backend Data LIF IP Address. Backend Data LIF IP Address is reachable at the given IP address
|
|
1205
1205
|
|
|
1206
|
-
<a id="
|
|
1206
|
+
<a id="labels-acd755"></a>• [`labels`](#labels-acd755) - Optional Block<br>Backend Labels. List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection
|
|
1207
1207
|
|
|
1208
|
-
<a id="
|
|
1208
|
+
<a id="usage-4b5bdb"></a>• [`limit_aggregate_usage`](#usage-4b5bdb) - Optional String<br>Limit Aggregate Usage. Fail provisioning if usage is above this percentage. Not enforced by default
|
|
1209
1209
|
|
|
1210
|
-
<a id="
|
|
1210
|
+
<a id="size-6ec0fc"></a>• [`limit_volume_size`](#size-6ec0fc) - Optional String<br>Limit Volume Size. Fail provisioning if requested volume size is above this value. Not enforced by default
|
|
1211
1211
|
|
|
1212
|
-
<a id="
|
|
1212
|
+
<a id="name-40ee01"></a>• [`management_lif_dns_name`](#name-40ee01) - Optional String<br>Backend Management LIF Name. Backend Management LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name
|
|
1213
1213
|
|
|
1214
|
-
<a id="
|
|
1214
|
+
<a id="lif-ip-e9ac96"></a>• [`management_lif_ip`](#lif-ip-e9ac96) - Optional String<br>Backend Management LIF IP Address. Backend Management LIF IP Address is reachable at the given IP address
|
|
1215
1215
|
|
|
1216
|
-
<a id="
|
|
1216
|
+
<a id="options-fcd1b5"></a>• [`nfs_mount_options`](#options-fcd1b5) - Optional String<br>NFS Mount Options. Comma-separated list of NFS mount options. Not enforced by default
|
|
1217
1217
|
|
|
1218
|
-
<a id="
|
|
1218
|
+
<a id="password-d5888a"></a>• [`password`](#password-d5888a) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#password-d5888a) below.
|
|
1219
1219
|
|
|
1220
|
-
<a id="
|
|
1220
|
+
<a id="region-744dc3"></a>• [`region`](#region-744dc3) - Optional String<br>Backend Region. Virtual Pool Region
|
|
1221
1221
|
|
|
1222
|
-
<a id="
|
|
1222
|
+
<a id="storage-1f1d4a"></a>• [`storage`](#storage-1f1d4a) - Optional Block<br>Virtual Storage Pools. List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection<br>See [Storage](#storage-1f1d4a) below.
|
|
1223
1223
|
|
|
1224
|
-
<a id="
|
|
1224
|
+
<a id="name-ad4529"></a>• [`storage_driver_name`](#name-ad4529) - Optional String<br>Storage Backend Driver. Configuration of Backend Name
|
|
1225
1225
|
|
|
1226
|
-
<a id="
|
|
1226
|
+
<a id="prefix-249cfa"></a>• [`storage_prefix`](#prefix-249cfa) - Optional String<br>Storage Prefix. Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated
|
|
1227
1227
|
|
|
1228
|
-
<a id="
|
|
1228
|
+
<a id="svm-d2e6f6"></a>• [`svm`](#svm-d2e6f6) - Optional String<br>Backend SVM. Storage virtual machine to use. Derived if an SVM managementLIF is specified
|
|
1229
1229
|
|
|
1230
|
-
<a id="
|
|
1230
|
+
<a id="certificate-b14a97"></a>• [`trusted_ca_certificate`](#certificate-b14a97) - Optional String<br>Trusted CA Certificate. Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth
|
|
1231
1231
|
|
|
1232
|
-
<a id="
|
|
1232
|
+
<a id="username-ee5508"></a>• [`username`](#username-ee5508) - Optional String<br>Username. Username to connect to the cluster/SVM
|
|
1233
1233
|
|
|
1234
|
-
<a id="
|
|
1234
|
+
<a id="defaults-44161c"></a>• [`volume_defaults`](#defaults-44161c) - Optional Block<br>Backend OnTap Volume Defaults. It controls how each volume is provisioned by default using these options in a special section of the configuration<br>See [Volume Defaults](#defaults-44161c) below.
|
|
1235
1235
|
|
|
1236
1236
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Auto Export Cidrs
|
|
1237
1237
|
|
|
1238
|
-
An [`auto_export_cidrs`](#
|
|
1238
|
+
An [`auto_export_cidrs`](#cidrs-af1113) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas`](#nas-ee38b4)) supports the following:
|
|
1239
1239
|
|
|
1240
|
-
<a id="
|
|
1240
|
+
<a id="prefixes-758f72"></a>• [`prefixes`](#prefixes-758f72) - Optional List<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint
|
|
1241
1241
|
|
|
1242
1242
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Client Private Key
|
|
1243
1243
|
|
|
1244
|
-
A [`client_private_key`](#
|
|
1244
|
+
A [`client_private_key`](#key-d50914) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas`](#nas-ee38b4)) supports the following:
|
|
1245
1245
|
|
|
1246
|
-
<a id="
|
|
1246
|
+
<a id="info-564dad"></a>• [`blindfold_secret_info`](#info-564dad) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-564dad) below.
|
|
1247
1247
|
|
|
1248
|
-
<a id="
|
|
1248
|
+
<a id="info-158d5b"></a>• [`clear_secret_info`](#info-158d5b) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-158d5b) below.
|
|
1249
1249
|
|
|
1250
1250
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Client Private Key Blindfold Secret Info
|
|
1251
1251
|
|
|
1252
|
-
A [`blindfold_secret_info`](#
|
|
1252
|
+
A [`blindfold_secret_info`](#info-564dad) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas.client_private_key`](#key-d50914)) supports the following:
|
|
1253
1253
|
|
|
1254
|
-
<a id="
|
|
1254
|
+
<a id="provider-ff5671"></a>• [`decryption_provider`](#provider-ff5671) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1255
1255
|
|
|
1256
|
-
<a id="
|
|
1256
|
+
<a id="location-978c72"></a>• [`location`](#location-978c72) - Optional String<br>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
|
|
1257
1257
|
|
|
1258
|
-
<a id="
|
|
1258
|
+
<a id="provider-1d8b9d"></a>• [`store_provider`](#provider-1d8b9d) - Optional String<br>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:///
|
|
1259
1259
|
|
|
1260
1260
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Client Private Key Clear Secret Info
|
|
1261
1261
|
|
|
1262
|
-
A [`clear_secret_info`](#
|
|
1262
|
+
A [`clear_secret_info`](#info-158d5b) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas.client_private_key`](#key-d50914)) supports the following:
|
|
1263
1263
|
|
|
1264
|
-
<a id="
|
|
1264
|
+
<a id="ref-2a92a3"></a>• [`provider_ref`](#ref-2a92a3) - Optional String<br>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:///
|
|
1265
1265
|
|
|
1266
|
-
<a id="
|
|
1266
|
+
<a id="url-38d6af"></a>• [`url`](#url-38d6af) - Optional String<br>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
|
|
1267
1267
|
|
|
1268
1268
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Password
|
|
1269
1269
|
|
|
1270
|
-
A [`password`](#
|
|
1270
|
+
A [`password`](#password-d5888a) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas`](#nas-ee38b4)) supports the following:
|
|
1271
1271
|
|
|
1272
|
-
<a id="
|
|
1272
|
+
<a id="info-c0864a"></a>• [`blindfold_secret_info`](#info-c0864a) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-c0864a) below.
|
|
1273
1273
|
|
|
1274
|
-
<a id="
|
|
1274
|
+
<a id="info-f0c477"></a>• [`clear_secret_info`](#info-f0c477) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-f0c477) below.
|
|
1275
1275
|
|
|
1276
1276
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Password Blindfold Secret Info
|
|
1277
1277
|
|
|
1278
|
-
A [`blindfold_secret_info`](#
|
|
1278
|
+
A [`blindfold_secret_info`](#info-c0864a) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas.password`](#password-d5888a)) supports the following:
|
|
1279
1279
|
|
|
1280
|
-
<a id="
|
|
1280
|
+
<a id="provider-30d653"></a>• [`decryption_provider`](#provider-30d653) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1281
1281
|
|
|
1282
|
-
<a id="
|
|
1282
|
+
<a id="location-01cddc"></a>• [`location`](#location-01cddc) - Optional String<br>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
|
|
1283
1283
|
|
|
1284
|
-
<a id="
|
|
1284
|
+
<a id="provider-e74b29"></a>• [`store_provider`](#provider-e74b29) - Optional String<br>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:///
|
|
1285
1285
|
|
|
1286
1286
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Password Clear Secret Info
|
|
1287
1287
|
|
|
1288
|
-
A [`clear_secret_info`](#
|
|
1288
|
+
A [`clear_secret_info`](#info-f0c477) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas.password`](#password-d5888a)) supports the following:
|
|
1289
1289
|
|
|
1290
|
-
<a id="
|
|
1290
|
+
<a id="ref-994a9b"></a>• [`provider_ref`](#ref-994a9b) - Optional String<br>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:///
|
|
1291
1291
|
|
|
1292
|
-
<a id="
|
|
1292
|
+
<a id="url-0ae493"></a>• [`url`](#url-0ae493) - Optional String<br>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
|
|
1293
1293
|
|
|
1294
1294
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Storage
|
|
1295
1295
|
|
|
1296
|
-
A [`storage`](#
|
|
1296
|
+
A [`storage`](#storage-1f1d4a) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas`](#nas-ee38b4)) supports the following:
|
|
1297
1297
|
|
|
1298
|
-
<a id="
|
|
1298
|
+
<a id="labels-a2c60d"></a>• [`labels`](#labels-a2c60d) - Optional Block<br>Storage Pool Labels. List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection
|
|
1299
1299
|
|
|
1300
|
-
<a id="
|
|
1300
|
+
<a id="defaults-debf79"></a>• [`volume_defaults`](#defaults-debf79) - Optional Block<br>Backend OnTap Volume Defaults. It controls how each volume is provisioned by default using these options in a special section of the configuration<br>See [Volume Defaults](#defaults-debf79) below.
|
|
1301
1301
|
|
|
1302
|
-
<a id="
|
|
1302
|
+
<a id="zone-24875d"></a>• [`zone`](#zone-24875d) - Optional String<br>Virtual Pool Zone. Virtual Storage Pool zone definition
|
|
1303
1303
|
|
|
1304
1304
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Storage Volume Defaults
|
|
1305
1305
|
|
|
1306
|
-
A [`volume_defaults`](#
|
|
1306
|
+
A [`volume_defaults`](#defaults-debf79) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas.storage`](#storage-1f1d4a)) supports the following:
|
|
1307
1307
|
|
|
1308
|
-
<a id="
|
|
1308
|
+
<a id="policy-8b4807"></a>• [`adaptive_qos_policy`](#policy-8b4807) - Optional String<br>Adaptive QOS Policy name. Enter Adaptive QOS Policy Name
|
|
1309
1309
|
|
|
1310
|
-
<a id="
|
|
1310
|
+
<a id="encryption-2d64c8"></a>• [`encryption`](#encryption-2d64c8) - Optional Bool<br>Enable Encryption. Enable NetApp volume encryption
|
|
1311
1311
|
|
|
1312
|
-
<a id="
|
|
1312
|
+
<a id="policy-2af745"></a>• [`export_policy`](#policy-2af745) - Optional String<br>Export Policy. Export policy to use
|
|
1313
1313
|
|
|
1314
|
-
<a id="
|
|
1314
|
+
<a id="qos-5b1018"></a>• [`no_qos`](#qos-5b1018) - Optional Block<br>Enable this option
|
|
1315
1315
|
|
|
1316
|
-
<a id="
|
|
1316
|
+
<a id="policy-148881"></a>• [`qos_policy`](#policy-148881) - Optional String<br>QOS Policy Name. Enter QOS Policy Name
|
|
1317
1317
|
|
|
1318
|
-
<a id="
|
|
1318
|
+
<a id="style-12479e"></a>• [`security_style`](#style-12479e) - Optional String<br>Security Style. Security style for new volumes
|
|
1319
1319
|
|
|
1320
|
-
<a id="
|
|
1320
|
+
<a id="dir-9371a8"></a>• [`snapshot_dir`](#dir-9371a8) - Optional Bool<br>Access to Snapshot Directory. Access to the .snapshot directory
|
|
1321
1321
|
|
|
1322
|
-
<a id="
|
|
1322
|
+
<a id="policy-0eddda"></a>• [`snapshot_policy`](#policy-0eddda) - Optional String<br>Snapshot Policy. Snapshot policy to use
|
|
1323
1323
|
|
|
1324
|
-
<a id="
|
|
1324
|
+
<a id="reserve-12e93c"></a>• [`snapshot_reserve`](#reserve-12e93c) - Optional String<br>Snapshot Reserved. Percentage of volume reserved for snapshots. '0' if snapshot policy is 'none', else ''
|
|
1325
1325
|
|
|
1326
|
-
<a id="
|
|
1326
|
+
<a id="reserve-24ca35"></a>• [`space_reserve`](#reserve-24ca35) - Optional String<br>Space Reservation Mode. Space reservation mode; “none” (thin) or “volume” (thick)
|
|
1327
1327
|
|
|
1328
|
-
<a id="
|
|
1328
|
+
<a id="clone-4af119"></a>• [`split_on_clone`](#clone-4af119) - Optional Bool<br>Split on Clone. Split a clone from its parent upon creation
|
|
1329
1329
|
|
|
1330
|
-
<a id="
|
|
1330
|
+
<a id="policy-72fb40"></a>• [`tiering_policy`](#policy-72fb40) - Optional String<br>Tiering Policy. Tiering policy to use. 'none' is default
|
|
1331
1331
|
|
|
1332
|
-
<a id="
|
|
1332
|
+
<a id="permissions-4d4b9f"></a>• [`unix_permissions`](#permissions-4d4b9f) - Optional Number<br>Unix Mode Permissions. Unix permission mode for new volumes. All allowed 777
|
|
1333
1333
|
|
|
1334
1334
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Volume Defaults
|
|
1335
1335
|
|
|
1336
|
-
A [`volume_defaults`](#
|
|
1336
|
+
A [`volume_defaults`](#defaults-44161c) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_nas`](#nas-ee38b4)) supports the following:
|
|
1337
1337
|
|
|
1338
|
-
<a id="
|
|
1338
|
+
<a id="policy-5cf457"></a>• [`adaptive_qos_policy`](#policy-5cf457) - Optional String<br>Adaptive QOS Policy name. Enter Adaptive QOS Policy Name
|
|
1339
1339
|
|
|
1340
|
-
<a id="
|
|
1340
|
+
<a id="encryption-4dfbbc"></a>• [`encryption`](#encryption-4dfbbc) - Optional Bool<br>Enable Encryption. Enable NetApp volume encryption
|
|
1341
1341
|
|
|
1342
|
-
<a id="
|
|
1342
|
+
<a id="policy-0deaef"></a>• [`export_policy`](#policy-0deaef) - Optional String<br>Export Policy. Export policy to use
|
|
1343
1343
|
|
|
1344
|
-
<a id="
|
|
1344
|
+
<a id="qos-c89839"></a>• [`no_qos`](#qos-c89839) - Optional Block<br>Enable this option
|
|
1345
1345
|
|
|
1346
|
-
<a id="
|
|
1346
|
+
<a id="policy-a6b485"></a>• [`qos_policy`](#policy-a6b485) - Optional String<br>QOS Policy Name. Enter QOS Policy Name
|
|
1347
1347
|
|
|
1348
|
-
<a id="
|
|
1348
|
+
<a id="style-363b98"></a>• [`security_style`](#style-363b98) - Optional String<br>Security Style. Security style for new volumes
|
|
1349
1349
|
|
|
1350
|
-
<a id="
|
|
1350
|
+
<a id="dir-e7c80e"></a>• [`snapshot_dir`](#dir-e7c80e) - Optional Bool<br>Access to Snapshot Directory. Access to the .snapshot directory
|
|
1351
1351
|
|
|
1352
|
-
<a id="
|
|
1352
|
+
<a id="policy-30c93e"></a>• [`snapshot_policy`](#policy-30c93e) - Optional String<br>Snapshot Policy. Snapshot policy to use
|
|
1353
1353
|
|
|
1354
|
-
<a id="
|
|
1354
|
+
<a id="reserve-8d8116"></a>• [`snapshot_reserve`](#reserve-8d8116) - Optional String<br>Snapshot Reserved. Percentage of volume reserved for snapshots. '0' if snapshot policy is 'none', else ''
|
|
1355
1355
|
|
|
1356
|
-
<a id="
|
|
1356
|
+
<a id="reserve-76626d"></a>• [`space_reserve`](#reserve-76626d) - Optional String<br>Space Reservation Mode. Space reservation mode; “none” (thin) or “volume” (thick)
|
|
1357
1357
|
|
|
1358
|
-
<a id="
|
|
1358
|
+
<a id="clone-ba0c1a"></a>• [`split_on_clone`](#clone-ba0c1a) - Optional Bool<br>Split on Clone. Split a clone from its parent upon creation
|
|
1359
1359
|
|
|
1360
|
-
<a id="
|
|
1360
|
+
<a id="policy-a691f5"></a>• [`tiering_policy`](#policy-a691f5) - Optional String<br>Tiering Policy. Tiering policy to use. 'none' is default
|
|
1361
1361
|
|
|
1362
|
-
<a id="
|
|
1362
|
+
<a id="permissions-d029cd"></a>• [`unix_permissions`](#permissions-d029cd) - Optional Number<br>Unix Mode Permissions. Unix permission mode for new volumes. All allowed 777
|
|
1363
1363
|
|
|
1364
1364
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San
|
|
1365
1365
|
|
|
1366
|
-
A [`netapp_backend_ontap_san`](#
|
|
1366
|
+
A [`netapp_backend_ontap_san`](#san-00fbe7) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident`](#trident-979b89)) supports the following:
|
|
1367
1367
|
|
|
1368
|
-
<a id="
|
|
1368
|
+
<a id="certificate-c977e7"></a>• [`client_certificate`](#certificate-c977e7) - Optional String<br>Client Certificate. Please Enter Base64-encoded value of client certificate. Used for certificate-based auth
|
|
1369
1369
|
|
|
1370
|
-
<a id="
|
|
1370
|
+
<a id="key-21636a"></a>• [`client_private_key`](#key-21636a) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Client Private Key](#key-21636a) below.
|
|
1371
1371
|
|
|
1372
|
-
<a id="
|
|
1372
|
+
<a id="name-04fb5c"></a>• [`data_lif_dns_name`](#name-04fb5c) - Optional String<br>Backend Data LIF Name. Backend Data LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name
|
|
1373
1373
|
|
|
1374
|
-
<a id="
|
|
1374
|
+
<a id="lif-ip-4ae4bf"></a>• [`data_lif_ip`](#lif-ip-4ae4bf) - Optional String<br>Backend Data LIF IP Address. Backend Data LIF IP Address is reachable at the given IP address
|
|
1375
1375
|
|
|
1376
|
-
<a id="
|
|
1376
|
+
<a id="name-ae3da6"></a>• [`igroup_name`](#name-ae3da6) - Optional String<br>iGroup Name. Name of the igroup for SAN volumes to use
|
|
1377
1377
|
|
|
1378
|
-
<a id="
|
|
1378
|
+
<a id="labels-dea506"></a>• [`labels`](#labels-dea506) - Optional Block<br>Backend Labels. List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection
|
|
1379
1379
|
|
|
1380
|
-
<a id="
|
|
1380
|
+
<a id="usage-943f2d"></a>• [`limit_aggregate_usage`](#usage-943f2d) - Optional Number<br>Limit Aggregate Usage. Fail provisioning if usage is above this percentage. Not enforced by default
|
|
1381
1381
|
|
|
1382
|
-
<a id="
|
|
1382
|
+
<a id="size-373b3e"></a>• [`limit_volume_size`](#size-373b3e) - Optional Number<br>Limit Volume Size. Fail provisioning if requested volume size in GBi is above this value. Not enforced by default
|
|
1383
1383
|
|
|
1384
|
-
<a id="
|
|
1384
|
+
<a id="name-1cf431"></a>• [`management_lif_dns_name`](#name-1cf431) - Optional String<br>Backend Management LIF Name. Backend Management LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name
|
|
1385
1385
|
|
|
1386
|
-
<a id="
|
|
1386
|
+
<a id="lif-ip-068761"></a>• [`management_lif_ip`](#lif-ip-068761) - Optional String<br>Backend Management LIF IP Address. Backend Management LIF IP Address is reachable at the given IP address
|
|
1387
1387
|
|
|
1388
|
-
<a id="
|
|
1388
|
+
<a id="chap-df8335"></a>• [`no_chap`](#chap-df8335) - Optional Block<br>Enable this option
|
|
1389
1389
|
|
|
1390
|
-
<a id="
|
|
1390
|
+
<a id="password-a3e536"></a>• [`password`](#password-a3e536) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#password-a3e536) below.
|
|
1391
1391
|
|
|
1392
|
-
<a id="
|
|
1392
|
+
<a id="region-449c58"></a>• [`region`](#region-449c58) - Optional String<br>Backend Region. Virtual Pool Region
|
|
1393
1393
|
|
|
1394
|
-
<a id="
|
|
1394
|
+
<a id="storage-a670cc"></a>• [`storage`](#storage-a670cc) - Optional Block<br>Virtual Storage Pools. List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection<br>See [Storage](#storage-a670cc) below.
|
|
1395
1395
|
|
|
1396
|
-
<a id="
|
|
1396
|
+
<a id="name-db73d5"></a>• [`storage_driver_name`](#name-db73d5) - Optional String<br>Storage Backend Driver. Configuration of Backend Name
|
|
1397
1397
|
|
|
1398
|
-
<a id="
|
|
1398
|
+
<a id="prefix-83eca9"></a>• [`storage_prefix`](#prefix-83eca9) - Optional String<br>Storage Prefix. Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated
|
|
1399
1399
|
|
|
1400
|
-
<a id="
|
|
1400
|
+
<a id="svm-69ccb8"></a>• [`svm`](#svm-69ccb8) - Optional String<br>Backend SVM. Storage virtual machine to use. Derived if an SVM managementLIF is specified
|
|
1401
1401
|
|
|
1402
|
-
<a id="
|
|
1402
|
+
<a id="certificate-d339d4"></a>• [`trusted_ca_certificate`](#certificate-d339d4) - Optional String<br>Trusted CA Certificate. Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth
|
|
1403
1403
|
|
|
1404
|
-
<a id="
|
|
1404
|
+
<a id="chap-8ecc57"></a>• [`use_chap`](#chap-8ecc57) - Optional Block<br>Device NetApp Backend ONTAP SAN CHAP Configuration. Device NetApp Backend ONTAP SAN CHAP configuration options for enabled CHAP<br>See [Use Chap](#chap-8ecc57) below.
|
|
1405
1405
|
|
|
1406
|
-
<a id="
|
|
1406
|
+
<a id="username-19c71a"></a>• [`username`](#username-19c71a) - Optional String<br>Username. Username to connect to the cluster/SVM
|
|
1407
1407
|
|
|
1408
|
-
<a id="
|
|
1408
|
+
<a id="defaults-41ed39"></a>• [`volume_defaults`](#defaults-41ed39) - Optional Block<br>Backend OnTap Volume Defaults. It controls how each volume is provisioned by default using these options in a special section of the configuration<br>See [Volume Defaults](#defaults-41ed39) below.
|
|
1409
1409
|
|
|
1410
1410
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Client Private Key
|
|
1411
1411
|
|
|
1412
|
-
A [`client_private_key`](#
|
|
1412
|
+
A [`client_private_key`](#key-21636a) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san`](#san-00fbe7)) supports the following:
|
|
1413
1413
|
|
|
1414
|
-
<a id="
|
|
1414
|
+
<a id="info-0012c5"></a>• [`blindfold_secret_info`](#info-0012c5) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-0012c5) below.
|
|
1415
1415
|
|
|
1416
|
-
<a id="
|
|
1416
|
+
<a id="info-b893ae"></a>• [`clear_secret_info`](#info-b893ae) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-b893ae) below.
|
|
1417
1417
|
|
|
1418
1418
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Client Private Key Blindfold Secret Info
|
|
1419
1419
|
|
|
1420
|
-
A [`blindfold_secret_info`](#
|
|
1420
|
+
A [`blindfold_secret_info`](#info-0012c5) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.client_private_key`](#key-21636a)) supports the following:
|
|
1421
1421
|
|
|
1422
|
-
<a id="
|
|
1422
|
+
<a id="provider-9af1be"></a>• [`decryption_provider`](#provider-9af1be) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1423
1423
|
|
|
1424
|
-
<a id="
|
|
1424
|
+
<a id="location-3b05c5"></a>• [`location`](#location-3b05c5) - Optional String<br>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
|
|
1425
1425
|
|
|
1426
|
-
<a id="
|
|
1426
|
+
<a id="provider-e476d8"></a>• [`store_provider`](#provider-e476d8) - Optional String<br>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:///
|
|
1427
1427
|
|
|
1428
1428
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Client Private Key Clear Secret Info
|
|
1429
1429
|
|
|
1430
|
-
A [`clear_secret_info`](#
|
|
1430
|
+
A [`clear_secret_info`](#info-b893ae) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.client_private_key`](#key-21636a)) supports the following:
|
|
1431
1431
|
|
|
1432
|
-
<a id="
|
|
1432
|
+
<a id="ref-4ed33e"></a>• [`provider_ref`](#ref-4ed33e) - Optional String<br>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:///
|
|
1433
1433
|
|
|
1434
|
-
<a id="
|
|
1434
|
+
<a id="url-f37cfb"></a>• [`url`](#url-f37cfb) - Optional String<br>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
|
|
1435
1435
|
|
|
1436
1436
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Password
|
|
1437
1437
|
|
|
1438
|
-
A [`password`](#
|
|
1438
|
+
A [`password`](#password-a3e536) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san`](#san-00fbe7)) supports the following:
|
|
1439
1439
|
|
|
1440
|
-
<a id="
|
|
1440
|
+
<a id="info-989e02"></a>• [`blindfold_secret_info`](#info-989e02) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-989e02) below.
|
|
1441
1441
|
|
|
1442
|
-
<a id="
|
|
1442
|
+
<a id="info-c9d3e6"></a>• [`clear_secret_info`](#info-c9d3e6) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-c9d3e6) below.
|
|
1443
1443
|
|
|
1444
1444
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Password Blindfold Secret Info
|
|
1445
1445
|
|
|
1446
|
-
A [`blindfold_secret_info`](#
|
|
1446
|
+
A [`blindfold_secret_info`](#info-989e02) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.password`](#password-a3e536)) supports the following:
|
|
1447
1447
|
|
|
1448
|
-
<a id="
|
|
1448
|
+
<a id="provider-4dc60f"></a>• [`decryption_provider`](#provider-4dc60f) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1449
1449
|
|
|
1450
|
-
<a id="
|
|
1450
|
+
<a id="location-e81953"></a>• [`location`](#location-e81953) - Optional String<br>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
|
|
1451
1451
|
|
|
1452
|
-
<a id="
|
|
1452
|
+
<a id="provider-6c7ad0"></a>• [`store_provider`](#provider-6c7ad0) - Optional String<br>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:///
|
|
1453
1453
|
|
|
1454
1454
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Password Clear Secret Info
|
|
1455
1455
|
|
|
1456
|
-
A [`clear_secret_info`](#
|
|
1456
|
+
A [`clear_secret_info`](#info-c9d3e6) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.password`](#password-a3e536)) supports the following:
|
|
1457
1457
|
|
|
1458
|
-
<a id="
|
|
1458
|
+
<a id="ref-c8f9a2"></a>• [`provider_ref`](#ref-c8f9a2) - Optional String<br>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:///
|
|
1459
1459
|
|
|
1460
|
-
<a id="
|
|
1460
|
+
<a id="url-7f1233"></a>• [`url`](#url-7f1233) - Optional String<br>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
|
|
1461
1461
|
|
|
1462
1462
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Storage
|
|
1463
1463
|
|
|
1464
|
-
A [`storage`](#
|
|
1464
|
+
A [`storage`](#storage-a670cc) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san`](#san-00fbe7)) supports the following:
|
|
1465
1465
|
|
|
1466
|
-
<a id="
|
|
1466
|
+
<a id="labels-6d4495"></a>• [`labels`](#labels-6d4495) - Optional Block<br>Storage Pool Labels. List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection
|
|
1467
1467
|
|
|
1468
|
-
<a id="
|
|
1468
|
+
<a id="defaults-1b70e1"></a>• [`volume_defaults`](#defaults-1b70e1) - Optional Block<br>Backend OnTap Volume Defaults. It controls how each volume is provisioned by default using these options in a special section of the configuration<br>See [Volume Defaults](#defaults-1b70e1) below.
|
|
1469
1469
|
|
|
1470
|
-
<a id="
|
|
1470
|
+
<a id="zone-09815a"></a>• [`zone`](#zone-09815a) - Optional String<br>Virtual Pool Zone. Virtual Storage Pool zone definition
|
|
1471
1471
|
|
|
1472
1472
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Storage Volume Defaults
|
|
1473
1473
|
|
|
1474
|
-
A [`volume_defaults`](#
|
|
1474
|
+
A [`volume_defaults`](#defaults-1b70e1) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.storage`](#storage-a670cc)) supports the following:
|
|
1475
1475
|
|
|
1476
|
-
<a id="
|
|
1476
|
+
<a id="policy-48be7e"></a>• [`adaptive_qos_policy`](#policy-48be7e) - Optional String<br>Adaptive QOS Policy name. Enter Adaptive QOS Policy Name
|
|
1477
1477
|
|
|
1478
|
-
<a id="
|
|
1478
|
+
<a id="encryption-ceadb7"></a>• [`encryption`](#encryption-ceadb7) - Optional Bool<br>Enable Encryption. Enable NetApp volume encryption
|
|
1479
1479
|
|
|
1480
|
-
<a id="
|
|
1480
|
+
<a id="policy-6a73df"></a>• [`export_policy`](#policy-6a73df) - Optional String<br>Export Policy. Export policy to use
|
|
1481
1481
|
|
|
1482
|
-
<a id="
|
|
1482
|
+
<a id="qos-66ba87"></a>• [`no_qos`](#qos-66ba87) - Optional Block<br>Enable this option
|
|
1483
1483
|
|
|
1484
|
-
<a id="
|
|
1484
|
+
<a id="policy-cdd6ba"></a>• [`qos_policy`](#policy-cdd6ba) - Optional String<br>QOS Policy Name. Enter QOS Policy Name
|
|
1485
1485
|
|
|
1486
|
-
<a id="
|
|
1486
|
+
<a id="style-9cbac7"></a>• [`security_style`](#style-9cbac7) - Optional String<br>Security Style. Security style for new volumes
|
|
1487
1487
|
|
|
1488
|
-
<a id="
|
|
1488
|
+
<a id="dir-e8e4eb"></a>• [`snapshot_dir`](#dir-e8e4eb) - Optional Bool<br>Access to Snapshot Directory. Access to the .snapshot directory
|
|
1489
1489
|
|
|
1490
|
-
<a id="
|
|
1490
|
+
<a id="policy-f49a2f"></a>• [`snapshot_policy`](#policy-f49a2f) - Optional String<br>Snapshot Policy. Snapshot policy to use
|
|
1491
1491
|
|
|
1492
|
-
<a id="
|
|
1492
|
+
<a id="reserve-c9f100"></a>• [`snapshot_reserve`](#reserve-c9f100) - Optional String<br>Snapshot Reserved. Percentage of volume reserved for snapshots. '0' if snapshot policy is 'none', else ''
|
|
1493
1493
|
|
|
1494
|
-
<a id="
|
|
1494
|
+
<a id="reserve-622793"></a>• [`space_reserve`](#reserve-622793) - Optional String<br>Space Reservation Mode. Space reservation mode; “none” (thin) or “volume” (thick)
|
|
1495
1495
|
|
|
1496
|
-
<a id="
|
|
1496
|
+
<a id="clone-52f374"></a>• [`split_on_clone`](#clone-52f374) - Optional Bool<br>Split on Clone. Split a clone from its parent upon creation
|
|
1497
1497
|
|
|
1498
|
-
<a id="
|
|
1498
|
+
<a id="policy-3b7297"></a>• [`tiering_policy`](#policy-3b7297) - Optional String<br>Tiering Policy. Tiering policy to use. 'none' is default
|
|
1499
1499
|
|
|
1500
|
-
<a id="
|
|
1500
|
+
<a id="permissions-ec7c50"></a>• [`unix_permissions`](#permissions-ec7c50) - Optional Number<br>Unix Mode Permissions. Unix permission mode for new volumes. All allowed 777
|
|
1501
1501
|
|
|
1502
1502
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap
|
|
1503
1503
|
|
|
1504
|
-
An [`use_chap`](#
|
|
1504
|
+
An [`use_chap`](#chap-8ecc57) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san`](#san-00fbe7)) supports the following:
|
|
1505
1505
|
|
|
1506
|
-
<a id="
|
|
1506
|
+
<a id="secret-9e90dd"></a>• [`chap_initiator_secret`](#secret-9e90dd) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Chap Initiator Secret](#secret-9e90dd) below.
|
|
1507
1507
|
|
|
1508
|
-
<a id="
|
|
1508
|
+
<a id="secret-5c8f36"></a>• [`chap_target_initiator_secret`](#secret-5c8f36) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Chap Target Initiator Secret](#secret-5c8f36) below.
|
|
1509
1509
|
|
|
1510
|
-
<a id="
|
|
1510
|
+
<a id="username-a4b55d"></a>• [`chap_target_username`](#username-a4b55d) - Optional String<br>CHAP Target Username. Target username. Required if useCHAP=true
|
|
1511
1511
|
|
|
1512
|
-
<a id="
|
|
1512
|
+
<a id="username-edfd02"></a>• [`chap_username`](#username-edfd02) - Optional String<br>CHAP Username. Inbound username. Required if useCHAP=true
|
|
1513
1513
|
|
|
1514
1514
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Initiator Secret
|
|
1515
1515
|
|
|
1516
|
-
A [`chap_initiator_secret`](#
|
|
1516
|
+
A [`chap_initiator_secret`](#secret-9e90dd) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.use_chap`](#chap-8ecc57)) supports the following:
|
|
1517
1517
|
|
|
1518
|
-
<a id="
|
|
1518
|
+
<a id="info-8c0f29"></a>• [`blindfold_secret_info`](#info-8c0f29) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-8c0f29) below.
|
|
1519
1519
|
|
|
1520
|
-
<a id="
|
|
1520
|
+
<a id="info-6f1429"></a>• [`clear_secret_info`](#info-6f1429) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-6f1429) below.
|
|
1521
1521
|
|
|
1522
1522
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Initiator Secret Blindfold Secret Info
|
|
1523
1523
|
|
|
1524
|
-
A [`blindfold_secret_info`](#
|
|
1524
|
+
A [`blindfold_secret_info`](#info-8c0f29) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.use_chap.chap_initiator_secret`](#secret-9e90dd)) supports the following:
|
|
1525
1525
|
|
|
1526
|
-
<a id="
|
|
1526
|
+
<a id="provider-bd4008"></a>• [`decryption_provider`](#provider-bd4008) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1527
1527
|
|
|
1528
|
-
<a id="
|
|
1528
|
+
<a id="location-ad6ef2"></a>• [`location`](#location-ad6ef2) - Optional String<br>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
|
|
1529
1529
|
|
|
1530
|
-
<a id="
|
|
1530
|
+
<a id="provider-5ad0fc"></a>• [`store_provider`](#provider-5ad0fc) - Optional String<br>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:///
|
|
1531
1531
|
|
|
1532
1532
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Initiator Secret Clear Secret Info
|
|
1533
1533
|
|
|
1534
|
-
A [`clear_secret_info`](#
|
|
1534
|
+
A [`clear_secret_info`](#info-6f1429) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.use_chap.chap_initiator_secret`](#secret-9e90dd)) supports the following:
|
|
1535
1535
|
|
|
1536
|
-
<a id="
|
|
1536
|
+
<a id="ref-28ec3d"></a>• [`provider_ref`](#ref-28ec3d) - Optional String<br>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:///
|
|
1537
1537
|
|
|
1538
|
-
<a id="
|
|
1538
|
+
<a id="url-2bde81"></a>• [`url`](#url-2bde81) - Optional String<br>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
|
|
1539
1539
|
|
|
1540
1540
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Target Initiator Secret
|
|
1541
1541
|
|
|
1542
|
-
A [`chap_target_initiator_secret`](#
|
|
1542
|
+
A [`chap_target_initiator_secret`](#secret-5c8f36) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.use_chap`](#chap-8ecc57)) supports the following:
|
|
1543
1543
|
|
|
1544
|
-
<a id="
|
|
1544
|
+
<a id="info-e86cf6"></a>• [`blindfold_secret_info`](#info-e86cf6) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-e86cf6) below.
|
|
1545
1545
|
|
|
1546
|
-
<a id="
|
|
1546
|
+
<a id="info-b8fd2a"></a>• [`clear_secret_info`](#info-b8fd2a) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-b8fd2a) below.
|
|
1547
1547
|
|
|
1548
1548
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Target Initiator Secret Blindfold Secret Info
|
|
1549
1549
|
|
|
1550
|
-
A [`blindfold_secret_info`](#
|
|
1550
|
+
A [`blindfold_secret_info`](#info-e86cf6) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.use_chap.chap_target_initiator_secret`](#secret-5c8f36)) supports the following:
|
|
1551
1551
|
|
|
1552
|
-
<a id="
|
|
1552
|
+
<a id="provider-9caccd"></a>• [`decryption_provider`](#provider-9caccd) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1553
1553
|
|
|
1554
|
-
<a id="
|
|
1554
|
+
<a id="location-e6732c"></a>• [`location`](#location-e6732c) - Optional String<br>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
|
|
1555
1555
|
|
|
1556
|
-
<a id="
|
|
1556
|
+
<a id="provider-234d9b"></a>• [`store_provider`](#provider-234d9b) - Optional String<br>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:///
|
|
1557
1557
|
|
|
1558
1558
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Target Initiator Secret Clear Secret Info
|
|
1559
1559
|
|
|
1560
|
-
A [`clear_secret_info`](#
|
|
1560
|
+
A [`clear_secret_info`](#info-b8fd2a) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san.use_chap.chap_target_initiator_secret`](#secret-5c8f36)) supports the following:
|
|
1561
1561
|
|
|
1562
|
-
<a id="
|
|
1562
|
+
<a id="ref-ef6816"></a>• [`provider_ref`](#ref-ef6816) - Optional String<br>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:///
|
|
1563
1563
|
|
|
1564
|
-
<a id="
|
|
1564
|
+
<a id="url-c7ec84"></a>• [`url`](#url-c7ec84) - Optional String<br>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
|
|
1565
1565
|
|
|
1566
1566
|
#### Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Volume Defaults
|
|
1567
1567
|
|
|
1568
|
-
A [`volume_defaults`](#
|
|
1568
|
+
A [`volume_defaults`](#defaults-41ed39) block (within [`custom_storage_config.storage_device_list.storage_devices.netapp_trident.netapp_backend_ontap_san`](#san-00fbe7)) supports the following:
|
|
1569
1569
|
|
|
1570
|
-
<a id="
|
|
1570
|
+
<a id="policy-7a81ee"></a>• [`adaptive_qos_policy`](#policy-7a81ee) - Optional String<br>Adaptive QOS Policy name. Enter Adaptive QOS Policy Name
|
|
1571
1571
|
|
|
1572
|
-
<a id="
|
|
1572
|
+
<a id="encryption-c21d96"></a>• [`encryption`](#encryption-c21d96) - Optional Bool<br>Enable Encryption. Enable NetApp volume encryption
|
|
1573
1573
|
|
|
1574
|
-
<a id="
|
|
1574
|
+
<a id="policy-89293d"></a>• [`export_policy`](#policy-89293d) - Optional String<br>Export Policy. Export policy to use
|
|
1575
1575
|
|
|
1576
|
-
<a id="
|
|
1576
|
+
<a id="qos-ff8e57"></a>• [`no_qos`](#qos-ff8e57) - Optional Block<br>Enable this option
|
|
1577
1577
|
|
|
1578
|
-
<a id="
|
|
1578
|
+
<a id="policy-a6ab4b"></a>• [`qos_policy`](#policy-a6ab4b) - Optional String<br>QOS Policy Name. Enter QOS Policy Name
|
|
1579
1579
|
|
|
1580
|
-
<a id="
|
|
1580
|
+
<a id="style-571bbf"></a>• [`security_style`](#style-571bbf) - Optional String<br>Security Style. Security style for new volumes
|
|
1581
1581
|
|
|
1582
|
-
<a id="
|
|
1582
|
+
<a id="dir-2146dd"></a>• [`snapshot_dir`](#dir-2146dd) - Optional Bool<br>Access to Snapshot Directory. Access to the .snapshot directory
|
|
1583
1583
|
|
|
1584
|
-
<a id="
|
|
1584
|
+
<a id="policy-d4844f"></a>• [`snapshot_policy`](#policy-d4844f) - Optional String<br>Snapshot Policy. Snapshot policy to use
|
|
1585
1585
|
|
|
1586
|
-
<a id="
|
|
1586
|
+
<a id="reserve-747c38"></a>• [`snapshot_reserve`](#reserve-747c38) - Optional String<br>Snapshot Reserved. Percentage of volume reserved for snapshots. '0' if snapshot policy is 'none', else ''
|
|
1587
1587
|
|
|
1588
|
-
<a id="
|
|
1588
|
+
<a id="reserve-a56086"></a>• [`space_reserve`](#reserve-a56086) - Optional String<br>Space Reservation Mode. Space reservation mode; “none” (thin) or “volume” (thick)
|
|
1589
1589
|
|
|
1590
|
-
<a id="
|
|
1590
|
+
<a id="clone-c26136"></a>• [`split_on_clone`](#clone-c26136) - Optional Bool<br>Split on Clone. Split a clone from its parent upon creation
|
|
1591
1591
|
|
|
1592
|
-
<a id="
|
|
1592
|
+
<a id="policy-ed80f4"></a>• [`tiering_policy`](#policy-ed80f4) - Optional String<br>Tiering Policy. Tiering policy to use. 'none' is default
|
|
1593
1593
|
|
|
1594
|
-
<a id="
|
|
1594
|
+
<a id="permissions-fafcc1"></a>• [`unix_permissions`](#permissions-fafcc1) - Optional Number<br>Unix Mode Permissions. Unix permission mode for new volumes. All allowed 777
|
|
1595
1595
|
|
|
1596
1596
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator
|
|
1597
1597
|
|
|
1598
|
-
A [`pure_service_orchestrator`](#
|
|
1598
|
+
A [`pure_service_orchestrator`](#orchestrator-2f7da0) block (within [`custom_storage_config.storage_device_list.storage_devices`](#devices-0c06af)) supports the following:
|
|
1599
1599
|
|
|
1600
|
-
<a id="
|
|
1600
|
+
<a id="arrays-8d07f5"></a>• [`arrays`](#arrays-8d07f5) - Optional Block<br>Arrays Configuration. Device configuration for PSO Arrays<br>See [Arrays](#arrays-8d07f5) below.
|
|
1601
1601
|
|
|
1602
|
-
<a id="
|
|
1602
|
+
<a id="cluster-id-deec96"></a>• [`cluster_id`](#cluster-id-deec96) - Optional String<br>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
|
|
1603
1603
|
|
|
1604
|
-
<a id="
|
|
1604
|
+
<a id="topology-123509"></a>• [`enable_storage_topology`](#topology-123509) - Optional Bool<br>Enable Storage Topology. This option is to enable/disable the csi topology feature for pso-csi
|
|
1605
1605
|
|
|
1606
|
-
<a id="
|
|
1606
|
+
<a id="topology-49b8dc"></a>• [`enable_strict_topology`](#topology-49b8dc) - Optional Bool<br>Enable Strict Topology. This option is to enable/disable the strict csi topology feature for pso-csi
|
|
1607
1607
|
|
|
1608
1608
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays
|
|
1609
1609
|
|
|
1610
|
-
An [`arrays`](#
|
|
1610
|
+
An [`arrays`](#arrays-8d07f5) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator`](#orchestrator-2f7da0)) supports the following:
|
|
1611
1611
|
|
|
1612
|
-
<a id="
|
|
1612
|
+
<a id="array-c04527"></a>• [`flash_array`](#array-c04527) - Optional Block<br>Flash Arrays. Specify what storage flash arrays should be managed the plugin<br>See [Flash Array](#array-c04527) below.
|
|
1613
1613
|
|
|
1614
|
-
<a id="
|
|
1614
|
+
<a id="blade-7c7dcb"></a>• [`flash_blade`](#blade-7c7dcb) - Optional Block<br>Flash Blades. Specify what storage flash blades should be managed the plugin<br>See [Flash Blade](#blade-7c7dcb) below.
|
|
1615
1615
|
|
|
1616
1616
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array
|
|
1617
1617
|
|
|
1618
|
-
A [`flash_array`](#
|
|
1618
|
+
A [`flash_array`](#array-c04527) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays`](#arrays-8d07f5)) supports the following:
|
|
1619
1619
|
|
|
1620
|
-
<a id="
|
|
1620
|
+
<a id="opt-a3469b"></a>• [`default_fs_opt`](#opt-a3469b) - Optional String<br>Default Filesystem Options. Block volume default mkfs options. Not recommended to change!
|
|
1621
1621
|
|
|
1622
|
-
<a id="
|
|
1622
|
+
<a id="type-18c7df"></a>• [`default_fs_type`](#type-18c7df) - Optional String<br>Default Filesystem Type. Block volume default filesystem type. Not recommended to change!
|
|
1623
1623
|
|
|
1624
|
-
<a id="
|
|
1624
|
+
<a id="opts-f84ca9"></a>• [`default_mount_opts`](#opts-f84ca9) - Optional List<br>Default Mount Options. Block volume default filesystem mount options. Not recommended to change!
|
|
1625
1625
|
|
|
1626
|
-
<a id="
|
|
1626
|
+
<a id="attachments-9c1979"></a>• [`disable_preempt_attachments`](#attachments-9c1979) - Optional Bool<br>Disable Preempt Attachments. Enable/Disable attachment preemption!
|
|
1627
1627
|
|
|
1628
|
-
<a id="
|
|
1628
|
+
<a id="arrays-d89f23"></a>• [`flash_arrays`](#arrays-d89f23) - Optional Block<br>Flash Arrays. For FlashArrays you must set the 'mgmt_endpoint' and 'api_token'<br>See [Flash Arrays](#arrays-d89f23) below.
|
|
1629
1629
|
|
|
1630
|
-
<a id="
|
|
1630
|
+
<a id="timeout-f04239"></a>• [`iscsi_login_timeout`](#timeout-f04239) - Optional Number<br>iSCSI Login Timeout. iSCSI login timeout in seconds. Not recommended to change!
|
|
1631
1631
|
|
|
1632
|
-
<a id="
|
|
1632
|
+
<a id="type-142357"></a>• [`san_type`](#type-142357) - Optional String<br>SAN Type. Block volume access protocol, either iSCSI or FC
|
|
1633
1633
|
|
|
1634
1634
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array Flash Arrays
|
|
1635
1635
|
|
|
1636
|
-
A [`flash_arrays`](#
|
|
1636
|
+
A [`flash_arrays`](#arrays-d89f23) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays.flash_array`](#array-c04527)) supports the following:
|
|
1637
1637
|
|
|
1638
|
-
<a id="
|
|
1638
|
+
<a id="token-1f3845"></a>• [`api_token`](#token-1f3845) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [API Token](#token-1f3845) below.
|
|
1639
1639
|
|
|
1640
|
-
<a id="
|
|
1640
|
+
<a id="labels-f20fdf"></a>• [`labels`](#labels-f20fdf) - Optional Block<br>Labels. The labels are optional, and can be any key-value pair for use with the PSO 'fleet' provisioner
|
|
1641
1641
|
|
|
1642
|
-
<a id="
|
|
1642
|
+
<a id="name-78301a"></a>• [`mgmt_dns_name`](#name-78301a) - Optional String<br>Management Endpoint Name. Management Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name
|
|
1643
1643
|
|
|
1644
|
-
<a id="
|
|
1644
|
+
<a id="mgmt-ip-d54061"></a>• [`mgmt_ip`](#mgmt-ip-d54061) - Optional String<br>Management Endpoint IP Address. Management Endpoint is reachable at the given IP address
|
|
1645
1645
|
|
|
1646
1646
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array Flash Arrays API Token
|
|
1647
1647
|
|
|
1648
|
-
An [`api_token`](#
|
|
1648
|
+
An [`api_token`](#token-1f3845) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays.flash_array.flash_arrays`](#arrays-d89f23)) supports the following:
|
|
1649
1649
|
|
|
1650
|
-
<a id="
|
|
1650
|
+
<a id="info-5e53e3"></a>• [`blindfold_secret_info`](#info-5e53e3) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-5e53e3) below.
|
|
1651
1651
|
|
|
1652
|
-
<a id="
|
|
1652
|
+
<a id="info-0b18f1"></a>• [`clear_secret_info`](#info-0b18f1) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-0b18f1) below.
|
|
1653
1653
|
|
|
1654
1654
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array Flash Arrays API Token Blindfold Secret Info
|
|
1655
1655
|
|
|
1656
|
-
A [`blindfold_secret_info`](#
|
|
1656
|
+
A [`blindfold_secret_info`](#info-5e53e3) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays.flash_array.flash_arrays.api_token`](#token-1f3845)) supports the following:
|
|
1657
1657
|
|
|
1658
|
-
<a id="
|
|
1658
|
+
<a id="provider-8f4669"></a>• [`decryption_provider`](#provider-8f4669) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1659
1659
|
|
|
1660
|
-
<a id="
|
|
1660
|
+
<a id="location-130277"></a>• [`location`](#location-130277) - Optional String<br>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
|
|
1661
1661
|
|
|
1662
|
-
<a id="
|
|
1662
|
+
<a id="provider-45b751"></a>• [`store_provider`](#provider-45b751) - Optional String<br>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:///
|
|
1663
1663
|
|
|
1664
1664
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array Flash Arrays API Token Clear Secret Info
|
|
1665
1665
|
|
|
1666
|
-
A [`clear_secret_info`](#
|
|
1666
|
+
A [`clear_secret_info`](#info-0b18f1) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays.flash_array.flash_arrays.api_token`](#token-1f3845)) supports the following:
|
|
1667
1667
|
|
|
1668
|
-
<a id="
|
|
1668
|
+
<a id="ref-bd5e27"></a>• [`provider_ref`](#ref-bd5e27) - Optional String<br>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:///
|
|
1669
1669
|
|
|
1670
|
-
<a id="
|
|
1670
|
+
<a id="url-dfb7b1"></a>• [`url`](#url-dfb7b1) - Optional String<br>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
|
|
1671
1671
|
|
|
1672
1672
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade
|
|
1673
1673
|
|
|
1674
|
-
A [`flash_blade`](#
|
|
1674
|
+
A [`flash_blade`](#blade-7c7dcb) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays`](#arrays-8d07f5)) supports the following:
|
|
1675
1675
|
|
|
1676
|
-
<a id="
|
|
1676
|
+
<a id="directory-6ce60f"></a>• [`enable_snapshot_directory`](#directory-6ce60f) - Optional Bool<br>Enable Snapshot Directory. Enable/Disable FlashBlade snapshots
|
|
1677
1677
|
|
|
1678
|
-
<a id="
|
|
1678
|
+
<a id="rules-faced2"></a>• [`export_rules`](#rules-faced2) - Optional String<br>NFS Export Rules. NFS Export rules
|
|
1679
1679
|
|
|
1680
|
-
<a id="
|
|
1680
|
+
<a id="blades-737048"></a>• [`flash_blades`](#blades-737048) - Optional Block<br>Flash Blades. For FlashBlades you must set the 'mgmt_endpoint', 'api_token' and nfs_endpoint<br>See [Flash Blades](#blades-737048) below.
|
|
1681
1681
|
|
|
1682
1682
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade Flash Blades
|
|
1683
1683
|
|
|
1684
|
-
A [`flash_blades`](#
|
|
1684
|
+
A [`flash_blades`](#blades-737048) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays.flash_blade`](#blade-7c7dcb)) supports the following:
|
|
1685
1685
|
|
|
1686
|
-
<a id="
|
|
1686
|
+
<a id="token-407c8d"></a>• [`api_token`](#token-407c8d) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [API Token](#token-407c8d) below.
|
|
1687
1687
|
|
|
1688
|
-
<a id="
|
|
1688
|
+
<a id="lables-ef43d7"></a>• [`lables`](#lables-ef43d7) - Optional Block<br>Labels. The labels are optional, and can be any key-value pair for use with the PSO 'fleet' provisioner
|
|
1689
1689
|
|
|
1690
|
-
<a id="
|
|
1690
|
+
<a id="name-d085d4"></a>• [`mgmt_dns_name`](#name-d085d4) - Optional String<br>Management Endpoint Name. Management Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name
|
|
1691
1691
|
|
|
1692
|
-
<a id="
|
|
1692
|
+
<a id="mgmt-ip-cd5f12"></a>• [`mgmt_ip`](#mgmt-ip-cd5f12) - Optional String<br>Management Endpoint IP Address. Management Endpoint is reachable at the given IP address
|
|
1693
1693
|
|
|
1694
|
-
<a id="
|
|
1694
|
+
<a id="name-2be4b1"></a>• [`nfs_endpoint_dns_name`](#name-2be4b1) - Optional String<br>NFS DNS Name. Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name
|
|
1695
1695
|
|
|
1696
|
-
<a id="
|
|
1696
|
+
<a id="endpoint-ip-e1cbf0"></a>• [`nfs_endpoint_ip`](#endpoint-ip-e1cbf0) - Optional String<br>NFS IP Address. Endpoint is reachable at the given IP address
|
|
1697
1697
|
|
|
1698
1698
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade Flash Blades API Token
|
|
1699
1699
|
|
|
1700
|
-
An [`api_token`](#
|
|
1700
|
+
An [`api_token`](#token-407c8d) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays.flash_blade.flash_blades`](#blades-737048)) supports the following:
|
|
1701
1701
|
|
|
1702
|
-
<a id="
|
|
1702
|
+
<a id="info-9eecd9"></a>• [`blindfold_secret_info`](#info-9eecd9) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-9eecd9) below.
|
|
1703
1703
|
|
|
1704
|
-
<a id="
|
|
1704
|
+
<a id="info-acc144"></a>• [`clear_secret_info`](#info-acc144) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-acc144) below.
|
|
1705
1705
|
|
|
1706
1706
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade Flash Blades API Token Blindfold Secret Info
|
|
1707
1707
|
|
|
1708
|
-
A [`blindfold_secret_info`](#
|
|
1708
|
+
A [`blindfold_secret_info`](#info-9eecd9) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays.flash_blade.flash_blades.api_token`](#token-407c8d)) supports the following:
|
|
1709
1709
|
|
|
1710
|
-
<a id="
|
|
1710
|
+
<a id="provider-580986"></a>• [`decryption_provider`](#provider-580986) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
1711
1711
|
|
|
1712
|
-
<a id="
|
|
1712
|
+
<a id="location-58545e"></a>• [`location`](#location-58545e) - Optional String<br>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
|
|
1713
1713
|
|
|
1714
|
-
<a id="
|
|
1714
|
+
<a id="provider-a4ab3a"></a>• [`store_provider`](#provider-a4ab3a) - Optional String<br>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:///
|
|
1715
1715
|
|
|
1716
1716
|
#### Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade Flash Blades API Token Clear Secret Info
|
|
1717
1717
|
|
|
1718
|
-
A [`clear_secret_info`](#
|
|
1718
|
+
A [`clear_secret_info`](#info-acc144) block (within [`custom_storage_config.storage_device_list.storage_devices.pure_service_orchestrator.arrays.flash_blade.flash_blades.api_token`](#token-407c8d)) supports the following:
|
|
1719
1719
|
|
|
1720
|
-
<a id="
|
|
1720
|
+
<a id="ref-993849"></a>• [`provider_ref`](#ref-993849) - Optional String<br>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:///
|
|
1721
1721
|
|
|
1722
|
-
<a id="
|
|
1722
|
+
<a id="url-9e1111"></a>• [`url`](#url-9e1111) - Optional String<br>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
|
|
1723
1723
|
|
|
1724
1724
|
#### Custom Storage Config Storage Interface List
|
|
1725
1725
|
|
|
1726
|
-
A [`storage_interface_list`](#
|
|
1726
|
+
A [`storage_interface_list`](#list-c6bbef) block (within [`custom_storage_config`](#custom-storage-config)) supports the following:
|
|
1727
1727
|
|
|
1728
|
-
<a id="
|
|
1728
|
+
<a id="interfaces-b05461"></a>• [`storage_interfaces`](#interfaces-b05461) - Optional Block<br>List of Interface. Configure storage interfaces for this App Stack site<br>See [Storage Interfaces](#interfaces-b05461) below.
|
|
1729
1729
|
|
|
1730
1730
|
#### Custom Storage Config Storage Interface List Storage Interfaces
|
|
1731
1731
|
|
|
1732
|
-
A [`storage_interfaces`](#
|
|
1732
|
+
A [`storage_interfaces`](#interfaces-b05461) block (within [`custom_storage_config.storage_interface_list`](#list-c6bbef)) supports the following:
|
|
1733
1733
|
|
|
1734
|
-
<a id="
|
|
1734
|
+
<a id="spec-608ea7"></a>• [`description_spec`](#spec-608ea7) - Optional String<br>Interface Description. Description for this Interface
|
|
1735
1735
|
|
|
1736
|
-
<a id="
|
|
1736
|
+
<a id="labels-b36c67"></a>• [`labels`](#labels-b36c67) - Optional Block<br>Interface Labels. Add Labels for this Interface, these labels can be used in firewall policy
|
|
1737
1737
|
|
|
1738
|
-
<a id="
|
|
1738
|
+
<a id="interface-4a2586"></a>• [`storage_interface`](#interface-4a2586) - Optional Block<br>Ethernet Interface. Ethernet Interface Configuration<br>See [Storage Interface](#interface-4a2586) below.
|
|
1739
1739
|
|
|
1740
1740
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface
|
|
1741
1741
|
|
|
1742
|
-
A [`storage_interface`](#
|
|
1742
|
+
A [`storage_interface`](#interface-4a2586) block (within [`custom_storage_config.storage_interface_list.storage_interfaces`](#interfaces-b05461)) supports the following:
|
|
1743
1743
|
|
|
1744
|
-
<a id="
|
|
1744
|
+
<a id="cluster-59eac5"></a>• [`cluster`](#cluster-59eac5) - Optional Block<br>Enable this option
|
|
1745
1745
|
|
|
1746
|
-
<a id="
|
|
1746
|
+
<a id="device-810ff0"></a>• [`device`](#device-810ff0) - Optional String<br>Ethernet Device. Interface configuration for the ethernet device
|
|
1747
1747
|
|
|
1748
|
-
<a id="
|
|
1748
|
+
<a id="client-4b0636"></a>• [`dhcp_client`](#client-4b0636) - Optional Block<br>Enable this option
|
|
1749
1749
|
|
|
1750
|
-
<a id="
|
|
1750
|
+
<a id="server-48aa6b"></a>• [`dhcp_server`](#server-48aa6b) - Optional Block<br>DHCPServerParametersType<br>See [DHCP Server](#server-48aa6b) below.
|
|
1751
1751
|
|
|
1752
|
-
<a id="
|
|
1752
|
+
<a id="config-318539"></a>• [`ipv6_auto_config`](#config-318539) - Optional Block<br>IPV6AutoConfigType<br>See [IPv6 Auto Config](#config-318539) below.
|
|
1753
1753
|
|
|
1754
|
-
<a id="
|
|
1754
|
+
<a id="primary-785400"></a>• [`is_primary`](#primary-785400) - Optional Block<br>Enable this option
|
|
1755
1755
|
|
|
1756
|
-
<a id="
|
|
1756
|
+
<a id="monitor-b33cb9"></a>• [`monitor`](#monitor-b33cb9) - Optional Block<br>Link Quality Monitoring Configuration. Link Quality Monitoring configuration for a network interface
|
|
1757
1757
|
|
|
1758
|
-
<a id="
|
|
1758
|
+
<a id="disabled-e66ec9"></a>• [`monitor_disabled`](#disabled-e66ec9) - Optional Block<br>Enable this option
|
|
1759
1759
|
|
|
1760
|
-
<a id="
|
|
1760
|
+
<a id="mtu-849be7"></a>• [`mtu`](#mtu-849be7) - Optional Number<br>Maximum Packet Size (MTU). Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384
|
|
1761
1761
|
|
|
1762
|
-
<a id="
|
|
1762
|
+
<a id="address-c1d6ce"></a>• [`no_ipv6_address`](#address-c1d6ce) - Optional Block<br>Enable this option
|
|
1763
1763
|
|
|
1764
|
-
<a id="
|
|
1764
|
+
<a id="node-5fb6ad"></a>• [`node`](#node-5fb6ad) - Optional String<br>Specific Node. Configuration will apply to a device on the given node
|
|
1765
1765
|
|
|
1766
|
-
<a id="
|
|
1766
|
+
<a id="primary-9f6634"></a>• [`not_primary`](#primary-9f6634) - Optional Block<br>Enable this option
|
|
1767
1767
|
|
|
1768
|
-
<a id="
|
|
1768
|
+
<a id="priority-4312f2"></a>• [`priority`](#priority-4312f2) - Optional Number<br>Priority. Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority
|
|
1769
1769
|
|
|
1770
|
-
<a id="
|
|
1770
|
+
<a id="network-93a0a9"></a>• [`site_local_inside_network`](#network-93a0a9) - Optional Block<br>Enable this option
|
|
1771
1771
|
|
|
1772
|
-
<a id="
|
|
1772
|
+
<a id="network-523dfb"></a>• [`site_local_network`](#network-523dfb) - Optional Block<br>Enable this option
|
|
1773
1773
|
|
|
1774
|
-
<a id="
|
|
1774
|
+
<a id="static-ip-dc5883"></a>• [`static_ip`](#static-ip-dc5883) - Optional Block<br>Static IP Parameters. Configure Static IP parameters<br>See [Static IP](#static-ip-dc5883) below.
|
|
1775
1775
|
|
|
1776
|
-
<a id="
|
|
1776
|
+
<a id="address-9e5d5b"></a>• [`static_ipv6_address`](#address-9e5d5b) - Optional Block<br>Static IP Parameters. Configure Static IP parameters<br>See [Static IPv6 Address](#address-9e5d5b) below.
|
|
1777
1777
|
|
|
1778
|
-
<a id="
|
|
1778
|
+
<a id="network-e547b9"></a>• [`storage_network`](#network-e547b9) - Optional Block<br>Enable this option
|
|
1779
1779
|
|
|
1780
|
-
<a id="
|
|
1780
|
+
<a id="untagged-c94d64"></a>• [`untagged`](#untagged-c94d64) - Optional Block<br>Enable this option
|
|
1781
1781
|
|
|
1782
|
-
<a id="
|
|
1782
|
+
<a id="vlan-id-8fd2c0"></a>• [`vlan_id`](#vlan-id-8fd2c0) - Optional Number<br>VLAN ID. Configure a VLAN tagged ethernet interface
|
|
1783
1783
|
|
|
1784
1784
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server
|
|
1785
1785
|
|
|
1786
|
-
A [`dhcp_server`](#
|
|
1786
|
+
A [`dhcp_server`](#server-48aa6b) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface`](#interface-4a2586)) supports the following:
|
|
1787
1787
|
|
|
1788
|
-
<a id="
|
|
1788
|
+
<a id="end-1cec49"></a>• [`automatic_from_end`](#end-1cec49) - Optional Block<br>Enable this option
|
|
1789
1789
|
|
|
1790
|
-
<a id="
|
|
1790
|
+
<a id="start-f789ae"></a>• [`automatic_from_start`](#start-f789ae) - Optional Block<br>Enable this option
|
|
1791
1791
|
|
|
1792
|
-
<a id="
|
|
1792
|
+
<a id="networks-408ded"></a>• [`dhcp_networks`](#networks-408ded) - Optional Block<br>DHCP Networks. List of networks from which DHCP Server can allocate IPv4 Addresses<br>See [DHCP Networks](#networks-408ded) below.
|
|
1793
1793
|
|
|
1794
|
-
<a id="
|
|
1794
|
+
<a id="map-4fbade"></a>• [`fixed_ip_map`](#map-4fbade) - Optional Block<br>Fixed MAC Address to IPv4 Assignments. Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client
|
|
1795
1795
|
|
|
1796
|
-
<a id="
|
|
1796
|
+
<a id="map-a5891b"></a>• [`interface_ip_map`](#map-a5891b) - Optional Block<br>Interface IPv4 Assignments. Specify static IPv4 addresses per node<br>See [Interface IP Map](#map-a5891b) below.
|
|
1797
1797
|
|
|
1798
1798
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server DHCP Networks
|
|
1799
1799
|
|
|
1800
|
-
A [`dhcp_networks`](#
|
|
1800
|
+
A [`dhcp_networks`](#networks-408ded) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.dhcp_server`](#server-48aa6b)) supports the following:
|
|
1801
1801
|
|
|
1802
|
-
<a id="
|
|
1802
|
+
<a id="address-a8681a"></a>• [`dgw_address`](#address-a8681a) - Optional String<br>Static IPv4 Configuration. Enter a IPv4 address from the network prefix to be used as the default gateway
|
|
1803
1803
|
|
|
1804
|
-
<a id="
|
|
1804
|
+
<a id="address-711eca"></a>• [`dns_address`](#address-711eca) - Optional String<br>Static IPv4 Configuration. Enter a IPv4 address from the network prefix to be used as the DNS server
|
|
1805
1805
|
|
|
1806
|
-
<a id="
|
|
1806
|
+
<a id="address-eb1830"></a>• [`first_address`](#address-eb1830) - Optional Block<br>Enable this option
|
|
1807
1807
|
|
|
1808
|
-
<a id="
|
|
1808
|
+
<a id="address-112d80"></a>• [`last_address`](#address-112d80) - Optional Block<br>Enable this option
|
|
1809
1809
|
|
|
1810
|
-
<a id="
|
|
1810
|
+
<a id="prefix-bfe30f"></a>• [`network_prefix`](#prefix-bfe30f) - Optional String<br>Network Prefix. Set the network prefix for the site. ex: 10.1.1.0/24
|
|
1811
1811
|
|
|
1812
|
-
<a id="
|
|
1812
|
+
<a id="settings-cd2c88"></a>• [`pool_settings`](#settings-cd2c88) - Optional String Defaults to `INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`<br>Possible values are `INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`, `EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`<br>[Enum: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS|EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS] Interface Network Type. Identifies the how to pick the network for Interface. Address ranges in DHCP pool list are used for IP Address allocation Address ranges in DHCP pool list are excluded from IP Address allocation
|
|
1813
1813
|
|
|
1814
|
-
<a id="
|
|
1814
|
+
<a id="pools-6d5b0e"></a>• [`pools`](#pools-6d5b0e) - Optional Block<br>DHCP Pools. List of non overlapping IP address ranges<br>See [Pools](#pools-6d5b0e) below.
|
|
1815
1815
|
|
|
1816
|
-
<a id="
|
|
1816
|
+
<a id="dgw-6794d2"></a>• [`same_as_dgw`](#dgw-6794d2) - Optional Block<br>Enable this option
|
|
1817
1817
|
|
|
1818
1818
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server DHCP Networks Pools
|
|
1819
1819
|
|
|
1820
|
-
A [`pools`](#
|
|
1820
|
+
A [`pools`](#pools-6d5b0e) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.dhcp_server.dhcp_networks`](#networks-408ded)) supports the following:
|
|
1821
1821
|
|
|
1822
|
-
<a id="
|
|
1822
|
+
<a id="end-ip-13d7f0"></a>• [`end_ip`](#end-ip-13d7f0) - Optional String<br>Ending 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
|
|
1823
1823
|
|
|
1824
|
-
<a id="
|
|
1824
|
+
<a id="start-ip-c730e8"></a>• [`start_ip`](#start-ip-c730e8) - Optional String<br>Starting 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
|
|
1825
1825
|
|
|
1826
1826
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server Interface IP Map
|
|
1827
1827
|
|
|
1828
|
-
An [`interface_ip_map`](#
|
|
1828
|
+
An [`interface_ip_map`](#map-a5891b) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.dhcp_server`](#server-48aa6b)) supports the following:
|
|
1829
1829
|
|
|
1830
|
-
<a id="
|
|
1830
|
+
<a id="map-bfe64e"></a>• [`interface_ip_map`](#map-bfe64e) - Optional Block<br>Site:Node to IPv4 Address Mapping. Specify static IPv4 addresses per site:node
|
|
1831
1831
|
|
|
1832
1832
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config
|
|
1833
1833
|
|
|
1834
|
-
An [`ipv6_auto_config`](#
|
|
1834
|
+
An [`ipv6_auto_config`](#config-318539) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface`](#interface-4a2586)) supports the following:
|
|
1835
1835
|
|
|
1836
|
-
<a id="
|
|
1836
|
+
<a id="host-14ce55"></a>• [`host`](#host-14ce55) - Optional Block<br>Enable this option
|
|
1837
1837
|
|
|
1838
|
-
<a id="
|
|
1838
|
+
<a id="router-1bf14a"></a>• [`router`](#router-1bf14a) - Optional Block<br>IPV6AutoConfigRouterType<br>See [Router](#router-1bf14a) below.
|
|
1839
1839
|
|
|
1840
1840
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router
|
|
1841
1841
|
|
|
1842
|
-
A [`router`](#
|
|
1842
|
+
A [`router`](#router-1bf14a) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.ipv6_auto_config`](#config-318539)) supports the following:
|
|
1843
1843
|
|
|
1844
|
-
<a id="
|
|
1844
|
+
<a id="config-f4006a"></a>• [`dns_config`](#config-f4006a) - Optional Block<br>IPV6DnsConfig<br>See [DNS Config](#config-f4006a) below.
|
|
1845
1845
|
|
|
1846
|
-
<a id="
|
|
1846
|
+
<a id="prefix-8eeea7"></a>• [`network_prefix`](#prefix-8eeea7) - Optional String<br>Network Prefix. Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862
|
|
1847
1847
|
|
|
1848
|
-
<a id="
|
|
1848
|
+
<a id="stateful-3f0c4f"></a>• [`stateful`](#stateful-3f0c4f) - Optional Block<br>DHCPIPV6 Stateful Server<br>See [Stateful](#stateful-3f0c4f) below.
|
|
1849
1849
|
|
|
1850
1850
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router DNS Config
|
|
1851
1851
|
|
|
1852
|
-
A [`dns_config`](#
|
|
1852
|
+
A [`dns_config`](#config-f4006a) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.ipv6_auto_config.router`](#router-1bf14a)) supports the following:
|
|
1853
1853
|
|
|
1854
|
-
<a id="
|
|
1854
|
+
<a id="list-26f12c"></a>• [`configured_list`](#list-26f12c) - Optional Block<br>IPV6DnsList<br>See [Configured List](#list-26f12c) below.
|
|
1855
1855
|
|
|
1856
|
-
<a id="
|
|
1856
|
+
<a id="dns-105acc"></a>• [`local_dns`](#dns-105acc) - Optional Block<br>IPV6LocalDnsAddress<br>See [Local DNS](#dns-105acc) below.
|
|
1857
1857
|
|
|
1858
1858
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router DNS Config Configured List
|
|
1859
1859
|
|
|
1860
|
-
A [`configured_list`](#
|
|
1860
|
+
A [`configured_list`](#list-26f12c) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.ipv6_auto_config.router.dns_config`](#config-f4006a)) supports the following:
|
|
1861
1861
|
|
|
1862
|
-
<a id="
|
|
1862
|
+
<a id="list-dca8c1"></a>• [`dns_list`](#list-dca8c1) - Optional List<br>DNS List. List of IPv6 Addresses acting as DNS servers
|
|
1863
1863
|
|
|
1864
1864
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router DNS Config Local DNS
|
|
1865
1865
|
|
|
1866
|
-
A [`local_dns`](#
|
|
1866
|
+
A [`local_dns`](#dns-105acc) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.ipv6_auto_config.router.dns_config`](#config-f4006a)) supports the following:
|
|
1867
1867
|
|
|
1868
|
-
<a id="
|
|
1868
|
+
<a id="address-5dbad2"></a>• [`configured_address`](#address-5dbad2) - Optional String<br>Configured Address. Configured address from the network prefix is chosen as DNS server
|
|
1869
1869
|
|
|
1870
|
-
<a id="
|
|
1870
|
+
<a id="address-2b5429"></a>• [`first_address`](#address-2b5429) - Optional Block<br>Enable this option
|
|
1871
1871
|
|
|
1872
|
-
<a id="
|
|
1872
|
+
<a id="address-20391e"></a>• [`last_address`](#address-20391e) - Optional Block<br>Enable this option
|
|
1873
1873
|
|
|
1874
1874
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router Stateful
|
|
1875
1875
|
|
|
1876
|
-
A [`stateful`](#
|
|
1876
|
+
A [`stateful`](#stateful-3f0c4f) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.ipv6_auto_config.router`](#router-1bf14a)) supports the following:
|
|
1877
1877
|
|
|
1878
|
-
<a id="
|
|
1878
|
+
<a id="end-e1c89c"></a>• [`automatic_from_end`](#end-e1c89c) - Optional Block<br>Enable this option
|
|
1879
1879
|
|
|
1880
|
-
<a id="
|
|
1880
|
+
<a id="start-66c4a7"></a>• [`automatic_from_start`](#start-66c4a7) - Optional Block<br>Enable this option
|
|
1881
1881
|
|
|
1882
|
-
<a id="
|
|
1882
|
+
<a id="networks-fd67f8"></a>• [`dhcp_networks`](#networks-fd67f8) - Optional Block<br>DHCP IPv6 Networks. List of networks from which DHCP server can allocate IP addresses<br>See [DHCP Networks](#networks-fd67f8) below.
|
|
1883
1883
|
|
|
1884
|
-
<a id="
|
|
1884
|
+
<a id="map-e9f314"></a>• [`fixed_ip_map`](#map-e9f314) - Optional Block<br>Fixed MAC Address to 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
|
|
1885
1885
|
|
|
1886
|
-
<a id="
|
|
1886
|
+
<a id="map-3da9a7"></a>• [`interface_ip_map`](#map-3da9a7) - Optional Block<br>Interface IPv6 Assignments. Map of Interface IPv6 assignments per node<br>See [Interface IP Map](#map-3da9a7) below.
|
|
1887
1887
|
|
|
1888
1888
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router Stateful DHCP Networks
|
|
1889
1889
|
|
|
1890
|
-
A [`dhcp_networks`](#
|
|
1890
|
+
A [`dhcp_networks`](#networks-fd67f8) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.ipv6_auto_config.router.stateful`](#stateful-3f0c4f)) supports the following:
|
|
1891
1891
|
|
|
1892
|
-
<a id="
|
|
1892
|
+
<a id="prefix-265048"></a>• [`network_prefix`](#prefix-265048) - Optional String<br>Network Prefix. Network Prefix to be used for IPv6 address auto configuration
|
|
1893
1893
|
|
|
1894
|
-
<a id="
|
|
1894
|
+
<a id="settings-5bdc75"></a>• [`pool_settings`](#settings-5bdc75) - Optional String Defaults to `INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`<br>Possible values are `INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`, `EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS`<br>[Enum: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS|EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS] Interface Network Type. Identifies the how to pick the network for Interface. Address ranges in DHCP pool list are used for IP Address allocation Address ranges in DHCP pool list are excluded from IP Address allocation
|
|
1895
1895
|
|
|
1896
|
-
<a id="
|
|
1896
|
+
<a id="pools-38579b"></a>• [`pools`](#pools-38579b) - Optional Block<br>DHCP Pools. List of non overlapping IP address ranges<br>See [Pools](#pools-38579b) below.
|
|
1897
1897
|
|
|
1898
1898
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router Stateful DHCP Networks Pools
|
|
1899
1899
|
|
|
1900
|
-
A [`pools`](#
|
|
1900
|
+
A [`pools`](#pools-38579b) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.ipv6_auto_config.router.stateful.dhcp_networks`](#networks-fd67f8)) supports the following:
|
|
1901
1901
|
|
|
1902
|
-
<a id="
|
|
1902
|
+
<a id="end-ip-011055"></a>• [`end_ip`](#end-ip-011055) - Optional String<br>Ending IPv6. Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix
|
|
1903
1903
|
|
|
1904
|
-
<a id="
|
|
1904
|
+
<a id="start-ip-6262b4"></a>• [`start_ip`](#start-ip-6262b4) - Optional String<br>Starting 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
|
|
1905
1905
|
|
|
1906
1906
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router Stateful Interface IP Map
|
|
1907
1907
|
|
|
1908
|
-
An [`interface_ip_map`](#
|
|
1908
|
+
An [`interface_ip_map`](#map-3da9a7) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.ipv6_auto_config.router.stateful`](#stateful-3f0c4f)) supports the following:
|
|
1909
1909
|
|
|
1910
|
-
<a id="
|
|
1910
|
+
<a id="map-4d7ea2"></a>• [`interface_ip_map`](#map-4d7ea2) - Optional Block<br>Site:Node to IPv6 Mapping. Map of Site:Node to IPv6 address
|
|
1911
1911
|
|
|
1912
1912
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IP
|
|
1913
1913
|
|
|
1914
|
-
A [`static_ip`](#
|
|
1914
|
+
A [`static_ip`](#static-ip-dc5883) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface`](#interface-4a2586)) supports the following:
|
|
1915
1915
|
|
|
1916
|
-
<a id="
|
|
1916
|
+
<a id="static-ip-9b5129"></a>• [`cluster_static_ip`](#static-ip-9b5129) - Optional Block<br>Cluster: Static IP Parameters. Configure Static IP parameters for cluster<br>See [Cluster Static IP](#static-ip-9b5129) below.
|
|
1917
1917
|
|
|
1918
|
-
<a id="
|
|
1918
|
+
<a id="static-ip-a071fb"></a>• [`node_static_ip`](#static-ip-a071fb) - Optional Block<br>Node: Static IP Parameters. Configure Static IP parameters for a node<br>See [Node Static IP](#static-ip-a071fb) below.
|
|
1919
1919
|
|
|
1920
1920
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IP Cluster Static IP
|
|
1921
1921
|
|
|
1922
|
-
A [`cluster_static_ip`](#
|
|
1922
|
+
A [`cluster_static_ip`](#static-ip-9b5129) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.static_ip`](#static-ip-dc5883)) supports the following:
|
|
1923
1923
|
|
|
1924
|
-
<a id="
|
|
1924
|
+
<a id="map-589443"></a>• [`interface_ip_map`](#map-589443) - Optional Block<br>Node to IP Mapping. Map of Node to Static IP configuration value, Key:Node, Value:IP Address
|
|
1925
1925
|
|
|
1926
1926
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IP Node Static IP
|
|
1927
1927
|
|
|
1928
|
-
A [`node_static_ip`](#
|
|
1928
|
+
A [`node_static_ip`](#static-ip-a071fb) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.static_ip`](#static-ip-dc5883)) supports the following:
|
|
1929
1929
|
|
|
1930
|
-
<a id="
|
|
1930
|
+
<a id="default-gw-6cd466"></a>• [`default_gw`](#default-gw-6cd466) - Optional String<br>Default Gateway. IP address of the default gateway
|
|
1931
1931
|
|
|
1932
|
-
<a id="
|
|
1932
|
+
<a id="address-2731b2"></a>• [`ip_address`](#address-2731b2) - Optional String<br>IP address/Prefix Length. IP address of the interface and prefix length
|
|
1933
1933
|
|
|
1934
1934
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IPv6 Address
|
|
1935
1935
|
|
|
1936
|
-
A [`static_ipv6_address`](#
|
|
1936
|
+
A [`static_ipv6_address`](#address-9e5d5b) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface`](#interface-4a2586)) supports the following:
|
|
1937
1937
|
|
|
1938
|
-
<a id="
|
|
1938
|
+
<a id="static-ip-c1e18b"></a>• [`cluster_static_ip`](#static-ip-c1e18b) - Optional Block<br>Cluster: Static IP Parameters. Configure Static IP parameters for cluster<br>See [Cluster Static IP](#static-ip-c1e18b) below.
|
|
1939
1939
|
|
|
1940
|
-
<a id="
|
|
1940
|
+
<a id="static-ip-d7a14c"></a>• [`node_static_ip`](#static-ip-d7a14c) - Optional Block<br>Node: Static IP Parameters. Configure Static IP parameters for a node<br>See [Node Static IP](#static-ip-d7a14c) below.
|
|
1941
1941
|
|
|
1942
1942
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IPv6 Address Cluster Static IP
|
|
1943
1943
|
|
|
1944
|
-
A [`cluster_static_ip`](#
|
|
1944
|
+
A [`cluster_static_ip`](#static-ip-c1e18b) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.static_ipv6_address`](#address-9e5d5b)) supports the following:
|
|
1945
1945
|
|
|
1946
|
-
<a id="
|
|
1946
|
+
<a id="map-44a65b"></a>• [`interface_ip_map`](#map-44a65b) - Optional Block<br>Node to IP Mapping. Map of Node to Static IP configuration value, Key:Node, Value:IP Address
|
|
1947
1947
|
|
|
1948
1948
|
#### Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IPv6 Address Node Static IP
|
|
1949
1949
|
|
|
1950
|
-
A [`node_static_ip`](#
|
|
1950
|
+
A [`node_static_ip`](#static-ip-d7a14c) block (within [`custom_storage_config.storage_interface_list.storage_interfaces.storage_interface.static_ipv6_address`](#address-9e5d5b)) supports the following:
|
|
1951
1951
|
|
|
1952
|
-
<a id="
|
|
1952
|
+
<a id="default-gw-e5c5f3"></a>• [`default_gw`](#default-gw-e5c5f3) - Optional String<br>Default Gateway. IP address of the default gateway
|
|
1953
1953
|
|
|
1954
|
-
<a id="
|
|
1954
|
+
<a id="address-13faca"></a>• [`ip_address`](#address-13faca) - Optional String<br>IP address/Prefix Length. IP address of the interface and prefix length
|
|
1955
1955
|
|
|
1956
1956
|
#### Enable Vgpu
|
|
1957
1957
|
|
|
@@ -1977,21 +1977,21 @@ A [`k8s_cluster`](#k8s-cluster) block supports the following:
|
|
|
1977
1977
|
|
|
1978
1978
|
A [`kubernetes_upgrade_drain`](#kubernetes-upgrade-drain) block supports the following:
|
|
1979
1979
|
|
|
1980
|
-
<a id="
|
|
1980
|
+
<a id="drain-0d0936"></a>• [`disable_upgrade_drain`](#drain-0d0936) - Optional Block<br>Enable this option
|
|
1981
1981
|
|
|
1982
|
-
<a id="
|
|
1982
|
+
<a id="drain-7e30d4"></a>• [`enable_upgrade_drain`](#drain-7e30d4) - Optional Block<br>Enable Node by Node Upgrade. Specify batch upgrade settings for worker nodes within a site<br>See [Enable Upgrade Drain](#drain-7e30d4) below.
|
|
1983
1983
|
|
|
1984
1984
|
#### Kubernetes Upgrade Drain Enable Upgrade Drain
|
|
1985
1985
|
|
|
1986
|
-
An [`enable_upgrade_drain`](#
|
|
1986
|
+
An [`enable_upgrade_drain`](#drain-7e30d4) block (within [`kubernetes_upgrade_drain`](#kubernetes-upgrade-drain)) supports the following:
|
|
1987
1987
|
|
|
1988
|
-
<a id="
|
|
1988
|
+
<a id="mode-668699"></a>• [`disable_vega_upgrade_mode`](#mode-668699) - Optional Block<br>Enable this option
|
|
1989
1989
|
|
|
1990
|
-
<a id="
|
|
1990
|
+
<a id="count-3aa796"></a>• [`drain_max_unavailable_node_count`](#count-3aa796) - Optional Number<br>Node Batch Size Count
|
|
1991
1991
|
|
|
1992
|
-
<a id="
|
|
1992
|
+
<a id="timeout-ac4ee9"></a>• [`drain_node_timeout`](#timeout-ac4ee9) - Optional Number<br>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)
|
|
1993
1993
|
|
|
1994
|
-
<a id="
|
|
1994
|
+
<a id="mode-9c557b"></a>• [`enable_vega_upgrade_mode`](#mode-9c557b) - Optional Block<br>Enable this option
|
|
1995
1995
|
|
|
1996
1996
|
#### Local Control Plane
|
|
1997
1997
|
|
|
@@ -2015,159 +2015,159 @@ A [`bgp_config`](#local-control-plane-bgp-config) block (within [`local_control_
|
|
|
2015
2015
|
|
|
2016
2016
|
A [`peers`](#local-control-plane-bgp-config-peers) block (within [`local_control_plane.bgp_config`](#local-control-plane-bgp-config)) supports the following:
|
|
2017
2017
|
|
|
2018
|
-
<a id="
|
|
2018
|
+
<a id="disabled-1a15e3"></a>• [`bfd_disabled`](#disabled-1a15e3) - Optional Block<br>Enable this option
|
|
2019
2019
|
|
|
2020
|
-
<a id="
|
|
2020
|
+
<a id="enabled-26ad69"></a>• [`bfd_enabled`](#enabled-26ad69) - Optional Block<br>BFD. BFD parameters<br>See [Bfd Enabled](#enabled-26ad69) below.
|
|
2021
2021
|
|
|
2022
|
-
<a id="
|
|
2022
|
+
<a id="disable-4f02ea"></a>• [`disable`](#disable-4f02ea) - Optional Block<br>Enable this option
|
|
2023
2023
|
|
|
2024
|
-
<a id="
|
|
2024
|
+
<a id="external-a31b05"></a>• [`external`](#external-a31b05) - Optional Block<br>External BGP Peer. External BGP Peer parameters<br>See [External](#external-a31b05) below.
|
|
2025
2025
|
|
|
2026
|
-
<a id="
|
|
2026
|
+
<a id="label-83d47a"></a>• [`label`](#label-83d47a) - Optional String<br>Label. Specify whether this peer should be
|
|
2027
2027
|
|
|
2028
|
-
<a id="
|
|
2028
|
+
<a id="metadata-fc2912"></a>• [`metadata`](#metadata-fc2912) - Optional Block<br>Message Metadata. MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create and replace APIs<br>See [Metadata](#metadata-fc2912) below.
|
|
2029
2029
|
|
|
2030
|
-
<a id="
|
|
2030
|
+
<a id="disabled-002c76"></a>• [`passive_mode_disabled`](#disabled-002c76) - Optional Block<br>Enable this option
|
|
2031
2031
|
|
|
2032
|
-
<a id="
|
|
2032
|
+
<a id="enabled-9a2bed"></a>• [`passive_mode_enabled`](#enabled-9a2bed) - Optional Block<br>Enable this option
|
|
2033
2033
|
|
|
2034
|
-
<a id="
|
|
2034
|
+
<a id="policies-2724a9"></a>• [`routing_policies`](#policies-2724a9) - Optional Block<br>BGP Routing Policy. List of rules which can be applied on all or particular nodes<br>See [Routing Policies](#policies-2724a9) below.
|
|
2035
2035
|
|
|
2036
2036
|
#### Local Control Plane BGP Config Peers Bfd Enabled
|
|
2037
2037
|
|
|
2038
|
-
A [`bfd_enabled`](#
|
|
2038
|
+
A [`bfd_enabled`](#enabled-26ad69) block (within [`local_control_plane.bgp_config.peers`](#local-control-plane-bgp-config-peers)) supports the following:
|
|
2039
2039
|
|
|
2040
|
-
<a id="
|
|
2040
|
+
<a id="multiplier-7b8f23"></a>• [`multiplier`](#multiplier-7b8f23) - Optional Number<br>Multiplier. Specify Number of missed packets to bring session down'
|
|
2041
2041
|
|
|
2042
|
-
<a id="
|
|
2042
|
+
<a id="milliseconds-2f0967"></a>• [`receive_interval_milliseconds`](#milliseconds-2f0967) - Optional Number<br>Minimum Receive Interval. BFD receive interval timer, in milliseconds
|
|
2043
2043
|
|
|
2044
|
-
<a id="
|
|
2044
|
+
<a id="milliseconds-eb8e23"></a>• [`transmit_interval_milliseconds`](#milliseconds-eb8e23) - Optional Number<br>Transmit Interval. BFD transmit interval timer, in milliseconds
|
|
2045
2045
|
|
|
2046
2046
|
#### Local Control Plane BGP Config Peers External
|
|
2047
2047
|
|
|
2048
|
-
An [`external`](#
|
|
2048
|
+
An [`external`](#external-a31b05) block (within [`local_control_plane.bgp_config.peers`](#local-control-plane-bgp-config-peers)) supports the following:
|
|
2049
2049
|
|
|
2050
|
-
<a id="
|
|
2050
|
+
<a id="address-267ce4"></a>• [`address`](#address-267ce4) - Optional String<br>Peer Address. Specify IPv4 peer address
|
|
2051
2051
|
|
|
2052
|
-
<a id="
|
|
2052
|
+
<a id="ipv6-b7bcf7"></a>• [`address_ipv6`](#ipv6-b7bcf7) - Optional String<br>Peer IPv6 Address. Specify peer IPv6 address
|
|
2053
2053
|
|
|
2054
|
-
<a id="
|
|
2054
|
+
<a id="asn-85f2ad"></a>• [`asn`](#asn-85f2ad) - Optional Number<br>ASN. Autonomous System Number for BGP peer
|
|
2055
2055
|
|
|
2056
|
-
<a id="
|
|
2056
|
+
<a id="gateway-546434"></a>• [`default_gateway`](#gateway-546434) - Optional Block<br>Enable this option
|
|
2057
2057
|
|
|
2058
|
-
<a id="
|
|
2058
|
+
<a id="gateway-v6-475482"></a>• [`default_gateway_v6`](#gateway-v6-475482) - Optional Block<br>Enable this option
|
|
2059
2059
|
|
|
2060
|
-
<a id="
|
|
2060
|
+
<a id="disable-b2f80e"></a>• [`disable`](#disable-b2f80e) - Optional Block<br>Enable this option
|
|
2061
2061
|
|
|
2062
|
-
<a id="
|
|
2062
|
+
<a id="disable-v6-d0e9ac"></a>• [`disable_v6`](#disable-v6-d0e9ac) - Optional Block<br>Enable this option
|
|
2063
2063
|
|
|
2064
|
-
<a id="
|
|
2064
|
+
<a id="connector-4797fa"></a>• [`external_connector`](#connector-4797fa) - Optional Block<br>Enable this option
|
|
2065
2065
|
|
|
2066
|
-
<a id="
|
|
2066
|
+
<a id="inet-10a45f"></a>• [`family_inet`](#inet-10a45f) - Optional Block<br>BGP Family Inet. Parameters for inet family<br>See [Family Inet](#inet-10a45f) below.
|
|
2067
2067
|
|
|
2068
|
-
<a id="
|
|
2068
|
+
<a id="site-47677d"></a>• [`from_site`](#site-47677d) - Optional Block<br>Enable this option
|
|
2069
2069
|
|
|
2070
|
-
<a id="
|
|
2070
|
+
<a id="site-v6-f9f6c0"></a>• [`from_site_v6`](#site-v6-f9f6c0) - Optional Block<br>Enable this option
|
|
2071
2071
|
|
|
2072
|
-
<a id="
|
|
2072
|
+
<a id="interface-5533f3"></a>• [`interface`](#interface-5533f3) - Optional Block<br>Object reference. 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<br>See [Interface](#interface-5533f3) below.
|
|
2073
2073
|
|
|
2074
|
-
<a id="
|
|
2074
|
+
<a id="list-b600b7"></a>• [`interface_list`](#list-b600b7) - Optional Block<br>Interface List. List of network interfaces<br>See [Interface List](#list-b600b7) below.
|
|
2075
2075
|
|
|
2076
|
-
<a id="
|
|
2076
|
+
<a id="key-766f91"></a>• [`md5_auth_key`](#key-766f91) - Optional String<br>MD5 Authentication Key. MD5 key for protecting BGP Sessions (RFC 2385)
|
|
2077
2077
|
|
|
2078
|
-
<a id="
|
|
2078
|
+
<a id="authentication-089c59"></a>• [`no_authentication`](#authentication-089c59) - Optional Block<br>Enable this option
|
|
2079
2079
|
|
|
2080
|
-
<a id="
|
|
2080
|
+
<a id="port-3f6206"></a>• [`port`](#port-3f6206) - Optional Number<br>Peer Port. Peer TCP port number
|
|
2081
2081
|
|
|
2082
|
-
<a id="
|
|
2082
|
+
<a id="offset-b3df90"></a>• [`subnet_begin_offset`](#offset-b3df90) - Optional Number<br>Offset From Beginning Of Subnet. Calculate peer address using offset from the beginning of the subnet
|
|
2083
2083
|
|
|
2084
|
-
<a id="
|
|
2084
|
+
<a id="offset-v6-f6832a"></a>• [`subnet_begin_offset_v6`](#offset-v6-f6832a) - Optional Number<br>Offset From Beginning Of Subnet. Calculate peer address using offset from the beginning of the subnet
|
|
2085
2085
|
|
|
2086
|
-
<a id="
|
|
2086
|
+
<a id="offset-82ad06"></a>• [`subnet_end_offset`](#offset-82ad06) - Optional Number<br>Offset From End Of Subnet. Calculate peer address using offset from the end of the subnet
|
|
2087
2087
|
|
|
2088
|
-
<a id="
|
|
2088
|
+
<a id="offset-v6-1ec41a"></a>• [`subnet_end_offset_v6`](#offset-v6-1ec41a) - Optional Number<br>Offset From End Of Subnet. Calculate peer address using offset from the end of the subnet
|
|
2089
2089
|
|
|
2090
2090
|
#### Local Control Plane BGP Config Peers External Family Inet
|
|
2091
2091
|
|
|
2092
|
-
A [`family_inet`](#
|
|
2092
|
+
A [`family_inet`](#inet-10a45f) block (within [`local_control_plane.bgp_config.peers.external`](#external-a31b05)) supports the following:
|
|
2093
2093
|
|
|
2094
|
-
<a id="
|
|
2094
|
+
<a id="disable-682cf9"></a>• [`disable`](#disable-682cf9) - Optional Block<br>Enable this option
|
|
2095
2095
|
|
|
2096
|
-
<a id="
|
|
2096
|
+
<a id="enable-509a26"></a>• [`enable`](#enable-509a26) - Optional Block<br>Enable this option
|
|
2097
2097
|
|
|
2098
2098
|
#### Local Control Plane BGP Config Peers External Interface
|
|
2099
2099
|
|
|
2100
|
-
An [`interface`](#
|
|
2100
|
+
An [`interface`](#interface-5533f3) block (within [`local_control_plane.bgp_config.peers.external`](#external-a31b05)) supports the following:
|
|
2101
2101
|
|
|
2102
|
-
<a id="
|
|
2102
|
+
<a id="name-c34380"></a>• [`name`](#name-c34380) - Optional String<br>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
|
|
2103
2103
|
|
|
2104
|
-
<a id="
|
|
2104
|
+
<a id="namespace-825d44"></a>• [`namespace`](#namespace-825d44) - Optional String<br>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
|
|
2105
2105
|
|
|
2106
|
-
<a id="
|
|
2106
|
+
<a id="tenant-e093f3"></a>• [`tenant`](#tenant-e093f3) - Optional String<br>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
|
|
2107
2107
|
|
|
2108
2108
|
#### Local Control Plane BGP Config Peers External Interface List
|
|
2109
2109
|
|
|
2110
|
-
An [`interface_list`](#
|
|
2110
|
+
An [`interface_list`](#list-b600b7) block (within [`local_control_plane.bgp_config.peers.external`](#external-a31b05)) supports the following:
|
|
2111
2111
|
|
|
2112
|
-
<a id="
|
|
2112
|
+
<a id="interfaces-4b6dac"></a>• [`interfaces`](#interfaces-4b6dac) - Optional Block<br>Interface List. List of network interfaces<br>See [Interfaces](#interfaces-4b6dac) below.
|
|
2113
2113
|
|
|
2114
2114
|
#### Local Control Plane BGP Config Peers External Interface List Interfaces
|
|
2115
2115
|
|
|
2116
|
-
An [`interfaces`](#
|
|
2116
|
+
An [`interfaces`](#interfaces-4b6dac) block (within [`local_control_plane.bgp_config.peers.external.interface_list`](#list-b600b7)) supports the following:
|
|
2117
2117
|
|
|
2118
|
-
<a id="
|
|
2118
|
+
<a id="name-4b6be4"></a>• [`name`](#name-4b6be4) - Optional String<br>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
|
|
2119
2119
|
|
|
2120
|
-
<a id="
|
|
2120
|
+
<a id="namespace-d3e0b3"></a>• [`namespace`](#namespace-d3e0b3) - Optional String<br>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
|
|
2121
2121
|
|
|
2122
|
-
<a id="
|
|
2122
|
+
<a id="tenant-92b6ee"></a>• [`tenant`](#tenant-92b6ee) - Optional String<br>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
|
|
2123
2123
|
|
|
2124
2124
|
#### Local Control Plane BGP Config Peers Metadata
|
|
2125
2125
|
|
|
2126
|
-
A [`metadata`](#
|
|
2126
|
+
A [`metadata`](#metadata-fc2912) block (within [`local_control_plane.bgp_config.peers`](#local-control-plane-bgp-config-peers)) supports the following:
|
|
2127
2127
|
|
|
2128
|
-
<a id="
|
|
2128
|
+
<a id="spec-61f831"></a>• [`description_spec`](#spec-61f831) - Optional String<br>Description. Human readable description
|
|
2129
2129
|
|
|
2130
|
-
<a id="
|
|
2130
|
+
<a id="name-858922"></a>• [`name`](#name-858922) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
2131
2131
|
|
|
2132
2132
|
#### Local Control Plane BGP Config Peers Routing Policies
|
|
2133
2133
|
|
|
2134
|
-
A [`routing_policies`](#
|
|
2134
|
+
A [`routing_policies`](#policies-2724a9) block (within [`local_control_plane.bgp_config.peers`](#local-control-plane-bgp-config-peers)) supports the following:
|
|
2135
2135
|
|
|
2136
|
-
<a id="
|
|
2136
|
+
<a id="policy-7d63f0"></a>• [`route_policy`](#policy-7d63f0) - Optional Block<br>BGP Routing policy. Route policy to be applied<br>See [Route Policy](#policy-7d63f0) below.
|
|
2137
2137
|
|
|
2138
2138
|
#### Local Control Plane BGP Config Peers Routing Policies Route Policy
|
|
2139
2139
|
|
|
2140
|
-
A [`route_policy`](#
|
|
2140
|
+
A [`route_policy`](#policy-7d63f0) block (within [`local_control_plane.bgp_config.peers.routing_policies`](#policies-2724a9)) supports the following:
|
|
2141
2141
|
|
|
2142
|
-
<a id="
|
|
2142
|
+
<a id="nodes-1892a0"></a>• [`all_nodes`](#nodes-1892a0) - Optional Block<br>Enable this option
|
|
2143
2143
|
|
|
2144
|
-
<a id="
|
|
2144
|
+
<a id="inbound-a3bfd0"></a>• [`inbound`](#inbound-a3bfd0) - Optional Block<br>Enable this option
|
|
2145
2145
|
|
|
2146
|
-
<a id="
|
|
2146
|
+
<a id="name-8e9d63"></a>• [`node_name`](#name-8e9d63) - Optional Block<br>Nodes. List of nodes on which BGP routing policy has to be applied<br>See [Node Name](#name-8e9d63) below.
|
|
2147
2147
|
|
|
2148
|
-
<a id="
|
|
2148
|
+
<a id="refs-5be373"></a>• [`object_refs`](#refs-5be373) - Optional Block<br>BGP routing policy. Select route policy to apply<br>See [Object Refs](#refs-5be373) below.
|
|
2149
2149
|
|
|
2150
|
-
<a id="
|
|
2150
|
+
<a id="outbound-98eaab"></a>• [`outbound`](#outbound-98eaab) - Optional Block<br>Enable this option
|
|
2151
2151
|
|
|
2152
2152
|
#### Local Control Plane BGP Config Peers Routing Policies Route Policy Node Name
|
|
2153
2153
|
|
|
2154
|
-
A [`node_name`](#
|
|
2154
|
+
A [`node_name`](#name-8e9d63) block (within [`local_control_plane.bgp_config.peers.routing_policies.route_policy`](#policy-7d63f0)) supports the following:
|
|
2155
2155
|
|
|
2156
|
-
<a id="
|
|
2156
|
+
<a id="node-edb042"></a>• [`node`](#node-edb042) - Optional List<br>Node of choice. Select BGP Session on which policy will be applied
|
|
2157
2157
|
|
|
2158
2158
|
#### Local Control Plane BGP Config Peers Routing Policies Route Policy Object Refs
|
|
2159
2159
|
|
|
2160
|
-
An [`object_refs`](#
|
|
2160
|
+
An [`object_refs`](#refs-5be373) block (within [`local_control_plane.bgp_config.peers.routing_policies.route_policy`](#policy-7d63f0)) supports the following:
|
|
2161
2161
|
|
|
2162
|
-
<a id="
|
|
2162
|
+
<a id="kind-6d1dc4"></a>• [`kind`](#kind-6d1dc4) - Optional String<br>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')
|
|
2163
2163
|
|
|
2164
|
-
<a id="
|
|
2164
|
+
<a id="name-031c69"></a>• [`name`](#name-031c69) - Optional String<br>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
|
|
2165
2165
|
|
|
2166
|
-
<a id="
|
|
2166
|
+
<a id="namespace-b2655c"></a>• [`namespace`](#namespace-b2655c) - Optional String<br>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
|
|
2167
2167
|
|
|
2168
|
-
<a id="
|
|
2168
|
+
<a id="tenant-22a640"></a>• [`tenant`](#tenant-22a640) - Optional String<br>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
|
|
2169
2169
|
|
|
2170
|
-
<a id="
|
|
2170
|
+
<a id="uid-32f24d"></a>• [`uid`](#uid-32f24d) - Optional String<br>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
|
|
2171
2171
|
|
|
2172
2172
|
#### Log Receiver
|
|
2173
2173
|
|
|
@@ -2191,9 +2191,9 @@ A [`master_node_configuration`](#master-node-configuration) block supports the f
|
|
|
2191
2191
|
|
|
2192
2192
|
An [`offline_survivability_mode`](#offline-survivability-mode) block supports the following:
|
|
2193
2193
|
|
|
2194
|
-
<a id="
|
|
2194
|
+
<a id="mode-565021"></a>• [`enable_offline_survivability_mode`](#mode-565021) - Optional Block<br>Enable this option
|
|
2195
2195
|
|
|
2196
|
-
<a id="
|
|
2196
|
+
<a id="mode-02f0c8"></a>• [`no_offline_survivability_mode`](#mode-02f0c8) - Optional Block<br>Enable this option
|
|
2197
2197
|
|
|
2198
2198
|
#### OS
|
|
2199
2199
|
|
|
@@ -2213,11 +2213,11 @@ A [`sriov_interfaces`](#sriov-interfaces) block supports the following:
|
|
|
2213
2213
|
|
|
2214
2214
|
A [`sriov_interface`](#sriov-interfaces-sriov-interface) block (within [`sriov_interfaces`](#sriov-interfaces)) supports the following:
|
|
2215
2215
|
|
|
2216
|
-
<a id="
|
|
2216
|
+
<a id="name-6aa533"></a>• [`interface_name`](#name-6aa533) - Optional String<br>Name of physical interface. Name of SR-IOV physical interface
|
|
2217
2217
|
|
|
2218
|
-
<a id="
|
|
2218
|
+
<a id="vfs-4b661e"></a>• [`number_of_vfio_vfs`](#vfs-4b661e) - Optional Number<br>Number of virtual functions reserved for vfio. Number of virtual functions reserved for VNFs and DPDK-based CNFs
|
|
2219
2219
|
|
|
2220
|
-
<a id="
|
|
2220
|
+
<a id="vfs-bf237a"></a>• [`number_of_vfs`](#vfs-bf237a) - Optional Number<br>Total number of virtual functions. Total number of virtual functions
|
|
2221
2221
|
|
|
2222
2222
|
#### Sw
|
|
2223
2223
|
|