Configures the cluster environment.

enviroment environment_name

Specify the environment used to deploy.

cluster_name

Specify the name used to uniquely identify the cluster.

Must be a string of 1-253 characters in the hostname-rule pattern. For information on the hostname-rule pattern, see the Input Pattern Types chapter.

Displays the overall status of the cluster.

Displays the TCP, UDP, NTP, and log-level information for the clusters.

log-level log_level

Specify the log level.

Must be one of the following:

• CRITICAL

• DEBUG

• ERROR

• INFO

• WARNING

Default Value: INFO.

ntp-info { false | true }

Specify whether to display the NTP clock server information.

Must be one of the following:

• false

• true

Default Value: true.

tcp-connections { false | true }

Specify whether to fetch TCP services and connections.

Must be one of the following:

• false

• true

Default Value: true.

udp-connections { false | true }

Spewcify whether to fetch UDP services and connections.

Must be one of the following:

• false

• true

Default Value: true.

Displays the cluster configuration logs.

Identify any issues before applying a patch.

Displays the patch status.

Cancels cluster synchronization.

Displays the cluster synchronization logs.

Runs cluster synchronization.

ansible-strategy ansible_strategy

Specify the Ansible strategy for synchronization.

Must be one of the following:

• free

• linear

Default Value: linear.

debug { false | true }

Specfy whether to debug.

Must be one of the following:

• false

• true

Default value: false

disable-partition-upgrade { false | true }

Specfy whether to apply the patch from cluster manager for full cluster synchronization.

Must be one of the following:

• false

• true

Default value: false

force-partition-redeploy { false | true }

Specify whether to force redeploying the partition.

Must be one of the following:

• false

• true

Default value: false

purge-data-disks { false | true }

Specify whether to purge data disks.

Must be one of the following:

• false

• true

Default value: false

reset-k8s-nodes { false | true }

Specify whether to reset the K8s nodes.

Must be one of the following:

• false

• true

Default value: false

sync-phase sync_phase

Specify the synchronization phase.

Must be one of the following:

• all

• distributed-registry

• netplan

• opscenter

• patch

• server-check

Default value: all

upgrade-strategy upgrade_strategy [ isolate-on-hardware-failure { true | false } node-tolerance tolerance_value ]

Specify the upgrade strategy.

Must be one of the following:

• auto

• concurrent : Concurrent upgrade

• rolling : Rolling upgrade

Default value: auto

isolate-on-hardware-failure [ true | false ] node-tolerance tolerance_value —Set a threshold for worker node failures that the system can tolerate. tolerance_value must be an integer from 0 to 9.

Setting isolate-on-hardware-failure to false or node-tolerance to 0 will prevent isolation.

vm-redeploy { false | true }

Specify whether to redeploy the VM.

Must be one of the following:

• false

• true

Default value: false

Displays the cluster synchronization status.

Displays the validate cluster logs.

Runs cluster validation.

log-level log_level

Specify the log level.

Must be one of the following:

• CRITICAL : Critical.

• DEBUG : Debug.

• ERROR : Error.

• INFO : Info.

• WARNING : Warning.

Default Value: INFO.

Displays the validate cluster logs.

Validates the cluster configuration.

k8s-label-checks { false | true }

Validates that the K8s nodes satisfy OAM label requirements.

Must be one of the following:

• false

• true

Default Value: true.

k8s-node-checks { false | true }

Validates the K8s nodes configuration size.

Must be one of the following:

• false

• true

Default Value: true.

log-level log_level

Specify the log-level.

Must be one of the following:

• CRITICAL

• DEBUG

• ERROR

• INFO

• WARNING

Default Value: INFO.

netplan { false | true }

Validates the netplan configuration.

Must be one of the following:

• false

• true

Default Value: true.

ntp { false | true }

Validates the NTP server configuration.

Must be one of the following:

• false

• true

Default Value: true.

proxy { false | true }

Validates the proxy server configuration.

Must be one of the following:

• false

• true

Default Value: true.

ssh { false | true }

Validates the SSH configuration.

Must be one of the following:

• false

• true

Default Value: true.

vip-checks { false | true }

Validates that no VIP is assigned to more than one virtual-ip groups.

Must be one of the following:

• false

• true

Default Value: true.

vmware-checks { false | true }

Validates the vcenter, datastore, and host configuration before synchronzing.

Must be one of the following:

• false

• true

Default Value: true.

Configure CNDP to use cert-manager to issue certificates for service endpoints.

cert-manager { enabled | disabled }

Specify to enable or disable cert-manager. By default, cert-manager is disabled in the CNDP managed K8s cluster.

Use the following command to optionally configure a certificate authority for a specific namespace:

secrets ca-cert namespace_name [ secret-name secret_name | private-key private_key _text | certificate ca_certificate_text ] 

secrets ca-cert namespace_name —Specify the namespace name targeted by the CA certificate.

secret-name secret_name —Specifiy the secret name that is used to store the CA certificate.

private-key private_key _text —Specify the content of the private key.

certificate ca_certificate_text —Specify the content of the certificate.

Configure the Cilium addon.

Important

This command is deprecated in 2024.02.1 and later releases.

cilium { enabled | disabled }

Specify to enable or disable the Cilium addon.

Configures the CPU Partitioner addon.

enabled

Specify whether to enable or disable the distributed-registry.

Must be one of the following:

• false

• true

Default Value: false.

tier tier

Specify the tier.

Must be one of the following:

• large

• medium

• small

Default Value: medium.

Configures the Ingress host name to be set to the registry.

ingress-hostname ingress_host_name

Specify the ingress hostname to be set to the registry, ip_address .nip.io or abc.com.

Must be a string.

Configure CNDP to support the installation of ESO operator in a namespace called external-secrets. It also supports the addition of custom resources called clusterSecretStore for provider type Vault to connect to the Vault engine.

external-secrets-operator { enabled | disabled }

Specify to enable or disable External Secrets Operator in a CNDP-managed K8s cluster.

Default value: Disabled

provider vault { server vault_server_url | namespace vault_namespace | path vault_path_reference | auth [ appRole | tokenSecretRef ] }

server vault_server_url—Specify the URL of the vault server.

namespace vault_namespace—Specify the namespace of the vault.

path vault_path_reference—Specify the path reference in vault.

auth [ appRole | tokenSecretRef ]—Specify the authentication type.

auth appRole supports the following parameters:

• auth appRole path app_role_path

• auth appRole roleId app_roleid

• auth appRole secretRef secret-id secret_id

auth tokenSecretRef supports the following parameters:

• auth tokenSecretRef name token_name

• auth tokenSecretRef key token_key_name

• auth tokenSecretRef token actual_token

Configure CNDP to support GitOps by installing Flux2 in the CNDP managed K8s cluster.

flux { enabled | disabled }

Specify to enable or disable Flux.

By default, Flux is disabled to reduce resource usage in the K8s cluster.

Configures the Ingress addon.

bind-ip-address-internal ip_address

Specify the internal bind IP address.

bind-ip-address ip_address

Specify the IP address for binding.

enabled { false | true }

Specify whether to enable or disable.

Must be one of the following:

• false

• true

Default Value: true.

failure-threshold failure_threshold

Specify the failure threshold.

Must be an integer.

Default Value: 3.

timeout-seconds timeout_duration

Specify the timeout in seconds.

Must be an integer.

Default Value: 1.

Configures the Istio addon.

istio enabled { false | true }

Specify whether to enable or disable the Istio addon. To enable, set to true.

Must be one of the following:

• false

• true

Default Value: false.

Configures the Kubernetes Dashboard addon.

enabled { false | true }

Specify whether to enable or disable the Kubernetes dashboard.

Must be one of the following:

• false

• true

Default Value: false.

Configures the Network addon.

type network_type

Specify the network type.

Must be one of the following:

• calico

Default Value: calico.

Configures the access of OS users to the SMI cluster upon login.

secure-access [ enabled | disabled ]

Specify to enable or disable secure access.

By default, secure access is disabled to reduce resource usage in the K8s cluster.

Configures auto-sync parameters.

lock-to-version lock_to_version

If the current cluster manager version (show version) matches this version, then the auto-sync applies.

Must be a string.

Upgrades the cluster to the current Cluster Manager version.

Allows installation of cluster-manager onto a cluster.

enabled { false | true }

Specify whether to enable or disable cluster-manager installation.

Must be one of the following:

• false

• true

Default Value: false.

ingress-hostname ingress_host_name

Specify the ingress host name to be set to the Cluster Manager in the format ip-address .nip.io or abc.com.

Must be a string.

iso-download-ip ip_address

Specify the existing IP address to be bound for direct ISO download.

netconf-ip ip_address

Specify the NETCONF IP address for the Ops Center.

netconf-port port_number

Specify the NETCONF port number for the Ops Center.

Must be an integer.

Default Value: 830.

password repo_password

Specify the password if any to log into the repository.

repository-local cluster_manager_cnf

Specify the Cluster Manager CNF.

repository product_chart_repo_url

Specify the product chart repo URL. See conforming rules in RFC 3305, RFC 3986, RFC 3966, RFC 4694, RFC 4759, RFC 4904, and RFC 5017.

ssh-port port_number

Specify the SSH port number for Ops Center.

Must be an integer.

Default Value: 2022.

username repo_user_name

Specify the user name if any to log into the repository.

Must be a string.

Configures the initial boot parameters for helm chart deployment.

first-boot-password password

Specify the initial boot password for the Cluster Manager CLI.

kube-control-plane-ip ssh_ip_address

Specify the SSH IP address for Cluster Manager Ops Center.

Configures the image pull secret.

image_pull_secret_name

Specify the name of the image pull secret.

Must be a string.

Enables a proxy for accessing online repositories.

ip ip_address

Specify the proxy's IP address.

Configures the kubernetes cluster-wide configurations.

additional-master-virtual-ip-cidr cidr_notation_netmask

Specfies the CIDR notation (netmask) of additional master virtual IP.

Must be an integer in the range of 0-32.

Default Value: 32.

additional-master-virtual-ip ip_address

Specfies the virtual IPv4 address used to provide additional access to the HA kubernetes masters. This must be set on initial cluster creation.

additional-master-virtual-ipv6-cidr cidr_notation_netmask

Specify the CIDR notation (netmask) of additional-master-virtual-ipv6.

Must be an integer in the range of 0-120.

Default Value: 112.

additional-master-virtual-ipv6 ipv6_address

Specify the virtual IPv6 address used to provide additional access to the HA kubernetes masters. This must be set on initial cluster creation.

addtional-master-virtual-ip-interface string

Specify the ethernet interface to which the additional master IP will be assigned. This will correspond to netplan network IDs.

Must be a string.

Default Value: ens192.

allow-insecure-registry { false | true }

Specify whether to allow the use of insecure docker and helm registries.

Must be one of the following:

• false

• true

Default Value: false.

calico-ipv6-cidr calico_ipv6_cidr

Specify the Calico IPv6 CIDR.

customization-image docker_image

Specify the Docker image to use for customizing the VMs deployed in the cluster.

Must be a string.

default-not-ready-toleration notready_toleration_time

Specify the pod eviction toleration time when the node is not ready, in seconds.

Default value: 30 seconds

default-unreachable-toleration unreachable_toleration_time

Specify the pod eviction toleration time when the node is unreachable, in seconds.

Default value: 30 seconds

docker-ipv6-cidr ipv6_cidr_docker_subnet

Specify the fixed IPv6 CIDR docker subnet.

Default Value: fd00::/80.

enable-pod-security-policy { false | true }

Specify whether to enable or disable pod security policy.

Must be one of the following:

• false

• true

Default Value: false.

enable-wireguard { false | true }

Specify whether to enable or disable Wireguard.

Must be one of the following:

• false

• true

Default Value: false.

error-on-automatic-rolling-upgrade { false | true }

Specify whether to allow or block automatic base image or firmware based rolling upgrades.

Must be one of the following:

• false

• true

Default Value: false.

ipv6-mode ipv6_mode

Specify whether to allow dual-stack pod and service subnets.

Must be one of the following:

• dual-stack

• none

Default Value: none.

keepalived-auth aes_encrypted_string

Specify the authentication password for Keepalived.

Default Value: 4be37dc3b4c90194d1600c483e10ad1d.

master-keepalived-multicast { false | true }

Specify whether to enable or disable master keepalived multicast.

Must be one of the following:

• false

• true

Default Value: false.

master-virtual-ip-cidr cidr_notation

Specify the CIDR notation of the additional master virtual IP.

Must be an integer in the range of 0-32.

Default Value: 32.

master-virtual-ip-interface ethernet_interface

Specify the ethernet interface to which the master IP will be assigned.

Must be a string.

Default Value: ens192.

master-virtual-ip ip_address

Specify the virtual IPv4 address used to make the kubernetes masters Highly Available (HA).

master-virtual-ipv6-cidr cidr_notation_netmask

Specify the CIDR notation (netmask) of additional-master-virtual-ipv6.

Must be an integer in the range of 0-112.

Default Value: 112.

master-virtual-ipv6 ipv6_address

Specify the virtual IPv6 address used to make the kubernetes masters HA. This must be set on initial cluster creation.

node-monitor-grace-period grace_period

Specify the node to be marked unhealthy after a period that it became unresponsive, in seconds.

Default value: 40 seconds

node-monitor-period monitor_period

Specify the period for syncing NodeStatus in NodeController, in seconds.

Default value: 5 seconds

node-status-update-frequency update_frequency

Specify the node status update interval from kubelet to kube-controller, in seconds.

Default value: 10 seconds

pod-subnet-ipv6 ipv6_pod_subnet

Specify the the IPv6 pod subnet to configure k8s and calico.

Default Value: fd20::0/112.

pod-subnet pod_subnet

Specify the pod subnet to configure k8s and calico.

Default Value: 192.168.0.0/16.

restrict-logging { false | true }

Specify whether to allow logging of critical information on failure for debugging purposes.

Must be one of the following:

• false

• true

Default Value: true.

Note	It's recommended to always set restrict-logging to true. Setting it to false is not secure and could result in unauthorized access to critical user data.

service-subnet-ipv6 ipv6_service_subnet

Specify the the IPv6 service subnet to configure k8s and calico.

Default Value: fd40::0/112.

service-subnet service_subnet

Specify the service subnet to configure k8s and calico.

Default Value: 10.96.0.0/12.

size cluster_size

Specify the cluster size.

Must be one of the following:

• functional-test-aio

• functional-test-ha

• production

Default Value: production.

virtual-ip-vrrp-router-id vrrp_router_id

Specify the VRRP router ID. If multiple instances of VRRP are in use on the same subnet, router ID must be unique. This is typically needed if running multiple SMI k8s clusters in the same subnet. Issues will show up with virtual IP not binding properly.

Must be an integer in the range of 1-255.

Define the CoreDNS passthrough configuration for updating policy and cache in the CoreDNS configmap.

configuration core-dns coredns_passthrough_configuration

Specify the Kubernetes CoreDNS passthrough configuration.

coredns_passthrough_configuration must be a string.

Configure Cilium on the K8s cluster.

configuration { enabled | disabled }

Specify to enable or disable Cilium.

Configures the default docker bridge network address pools.

base docker_bridge_subnet

Specify the docker bridge subnet.

Default Value: 172.17.0.0/16.

pool-name docker_bridge_address_pool_name

Specify the pool name of the docker bridge address pool.

Must be a string.

size size

Specify the size. For example, 16, 24, etc.

Must be an integer in the range of 8-24.

Default Value: 24.

Configure the size of HDD allocated for UPF.

disk-size disk_size

Configure the disk size allocated to the UPF in gigabytes. The disk size can range from 16 to 999 GB, with a default setting of 16 GB.

Note	Consider the available space on the node while configuring the disk size.

Configures the default configuration that applies to all nodes. All options are overridable at the node level.

host-profile host_profile_name

Specify the customizable tuning details package.

ssh-connection-private-key private_key

Specify the SSH private key used for connecting to the node.

ssh-username user_name

Specify the SSH user name used for connecting to the node.

Must be a string.

Configures the initial boot parameters for the node.

default-user-password default_user_password

Specify the password for the default user.

default-user-ssh-public-key default_user_ssh_public_key

Specify the public keys allowed to connect via SSH for the default user.

Must be a string.

default-user default_user_name

Specify the default user created when this node is deployed.

Must be a string.

default-user-password-expiration-days default_user_password_expiration_days

Specify the password expiration days for the default user.

Must be an integer in the range of 1-9999.

Configures initial boot netplan parameters.

renderer renderer_type

Specify to use the given networking backend for this definition.

Must be one of the following:

• NetworkManager

• networkd

Configures netplan bonds device type.

accept-ra { false | true }

Specify whether to accept or reject the Router Advertisement that would have the kernel configure IPv6 by itself.

Must be one of the following:

• false

• true

addresses ip_address/prefix_length

Specify to add static addresses to the interface in addition to the ones received through DHCP or RA.

critical { false | true }

Designate the connection as "critical to the system", meaning that special care will be taken by systemd-networkd to not release the IP from DHCP when the daemon is restarted.

Must be one of the following:

• false

• true

device-id device_id

Specify the netplan device ID.

Must be a string.

dhcp-identifier dhcp_identifier

Assign the setting (when set to mac) over to systemd-networkd to use the device’s MAC address as a unique identifier rather than a RFC4361-compliant Client ID.

Must be a string.

dhcp4 { false | true }

Specify whether to enable or disable DHCP for IPv4.

Must be one of the following:

• false

• true

dhcp6 { false | true }

Specify whether to enable or disable DHCP for IPv6.

Must be one of the following:

• false

• true

gateway4 ipv4_address

Specify the default gateway for IPv4.

gateway6 ipv6_address

Specify the default gateway for IPv6.

interfaces id_list

Specify the ID list. All devices matching this ID list will be added to the bond.

Must be a string.

ipv6-privacy { false | true }

Specify whether to enable or disable IPv6 Privacy Extensions (RFC 4941) for the specified interface, and prefer temporary addresses.

Must be one of the following:

• false

• true

link-local link_local_address

Specify the link-local addresses to bring up.

Must be one of the following:

• ipv4

• ipv6

macaddress mac_address

Specify the MAC address.

mtu number_of_mtu

Specify the Maximum Transmission Unit (MTU) for the interface.

Must be an integer.

Note	It is recommended to set MTU to the lowest path MTU.

optional { false | true }

Specify whether an optional device is required for booting.

Must be one of the following:

• false

• true

renderer renderer_type

Specify to use the given networking backend for this definition.

Must be one of the following:

• NetworkManager

• networkd

Overrides the default DHCP4 behavior.

hostname host_name

Specify the host name sent to the DHCP server, instead of the machine’s host name.

Must be a string.

route-metric route_metric_value

Specify the default metric value for automatically-added routes. Use this to prioritize routes for devices by setting a higher metric on a preferred interface.

Must be an integer.

send-hostname { false | true }

Specify whether the machine’s host name will be sent to the DHCP server. When set to true, the machine’s host name will be sent to the DHCP server.

Must be one of the following:

• false

• true

use-dns { false | true }

Specify whether the DNS servers received from the DHCP server will be used, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-hostname { false | true }

Specify whether the host name received from the DHCP server will be set as the transient host name of the system.

Must be one of the following:

• false

• true

use-mtu { false | true }

Specify whether the MTU received from the DHCP server will be set as the MTU of the network interface. When set to false, the MTU advertised by the DHCP server will be ignored.

Must be one of the following:

• false

• true

use-ntp { false | true }

Specify whether the NTP servers received from the DHCP server will be used by systemd-timesyncd, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-routes { false | true }

Specify whether the routes received from the DHCP server will be installed in the routing table normally. When set to false, routes from the DHCP server will be ignored. In such a scenario, the user is responsible for adding static routes (if required) for correct network operation. This allows users to avoid installing a default gateway for interfaces configured through DHCP.

Must be one of the following:

• false

• true

Overrides the default DHCP6 behavior.

hostname host_name

Specify the host name sent to the DHCP server, instead of the machine’s host name.

Must be a string.

route-metric route_metric_value

Specify the default metric value for automatically-added routes. Use this to prioritize routes for devices by setting a higher metric on a preferred interface.

Must be an integer.

send-hostname { false | true }

Specify whether the machine’s host name will be sent to the DHCP server. When set to true, the machine’s host name will be sent to the DHCP server.

Must be one of the following:

• false

• true

use-dns { false | true }

Specify whether the DNS servers received from the DHCP server will be used, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-hostname { false | true }

Specify whether the host name received from the DHCP server will be set as the transient host name of the system.

Must be one of the following:

• false

• true

use-mtu { false | true }

Specify whether the MTU received from the DHCP server will be set as the MTU of the network interface. When set to false, the MTU advertised by the DHCP server will be ignored.

Must be one of the following:

• false

• true

use-ntp { false | true }

Specify whether the NTP servers received from the DHCP server will be used by systemd-timesyncd, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-routes { false | true }

Specify whether the routes received from the DHCP server will be installed in the routing table normally. When set to false, routes from the DHCP server will be ignored. In such a scenario, the user is responsible for adding static routes (if required) for correct network operation. This allows users to avoid installing a default gateway for interfaces configured through DHCP.

Must be one of the following:

• false

• true

Configures the DNS servers and search domains.

addresses ip_addresses

Specify the DNS server IP address.

search domain_name

Specify the search domain name.

Must be a string.

Configures types of addresses that are not required for a device to be considered online.

optional-addresses optional_addresses

Specify the address type that is required for a device to be considered online.

Must be one of the following:

• dhcp4

• dhcp6

• ipv4-ll

• ipv6-ra

• static

Configures customization parameters for special bonding options.

ad-select aggregation_selection_mode

Specify the aggregation selection mode.

Must be one of the following:

• bandwidth

• count

• stable

all-slaves-active { false | true }

Specify whether the bond should drop or deliver the duplicate frames received on inactive ports.

Must be one of the following:

• false

• true

arp-interval arp_interval_value

Specify the interval value for how to determine the frequency of ARP link monitoring.

Must be a string.

arp-ip-targets ipv4_address

Specify the IPs of other hosts on the link which should be sent ARP requests in order to validate that a slave is up.

down-delay down_delay_interval

Specify the delay before disabling a link once the link has been lost.

Must be a string.

fail-over-mac-policy failover_mac_policy

Specify whether to set all slaves to the same MAC address when adding them to the bond, or how else the system should handle MAC addresses.

Must be one of the following:

• active

• follow

• none

gratuitous-arp arp_packets

Specify the number of ARP packets to send after failover.

Must be an integer in the range of 1-255.

lacp-rate lacp_rate

Specify the rate at which Link Aggregation Control Protocol Data Unit (LACPDU) are transmitted.

Must be one of the following:

• fast

• slow

learn-packet-interval learn_packet_interval

Specify the interval between sending learning packets to each slave.

Must be a string.

mii-monitor-interval mii_monitor_interval

Specify the interval for MII monitoring. That is, verifying if an interface of the bond has carrier.

Must be a string.

min-links minimum_links

Specify the minimum number of link up in a bond to consider the bond interface to be up.

Must be an integer.

mode bonding_mode

Specify the bonding mode used for the interfaces.

Must be one of the following:

• 802.3ad

• active-backup

• balance-alb

• balance-rr

• balance-tlb

• balance-xor

• broadcast

packets-per-slave packets_per_slave

Specify the number of packets to transmit on a slave before switching to the next.

Must be an integer in the range of 0-65535.

primary-reselect-policy reselection_policy

Specify the reselection policy for the primary slave.

Must be one of the following:

• always

• better

• failure

primary primary_device

Specify the device to be used as a primary slave, or preferred device to use as a slave for the bond, whenever it is available.

Must be a string.

resend-igmp igmp_reports

Specify the number of IGMP membership reports issued on a failover event.

Must be an integer in the range of 0-255.

transmit-hash-policy transmit_hash_policy

Specify the transmit hash policy for the selection of slaves.

Must be one of the following:

• encap2+3

• encap3+4

• layer2+3

• layer2

• layer3+4

up-delay up_delay_interval

Specify the delay before enabling a link once the link is physically up.

Must be a string.

Configures static routing for the device.

from source_ip_address

Specify the source IP address for traffic going through the route.

metric relative_priority_value

Specify the relative priority of the route.

Must be an integer.

on-link { false | true }

Specify whether the route is directly connected to the interface. When set to true, specifies that the route is directly connected to the interface.

Must be one of the following:

• false

• true

scope route_scope

Specify the route scope and how wide-ranging it is to the network.

Must be one of the following:

• global

• host

• link

table table_number

Specify the table number to use for the route.

Must be an integer in the range of 1-maximum.

type route_type

Specify the route type.

Must be one of the following:

• blackhole

• prohibit

• unicast

• unreachhable

via gateway_ip_address

Specify the gateway IP address to use for this route.

destination_ip_address

Specify the destination IP address for the route.

Configures policy routing for the device.

from source_ip_address

Specify the source IP address to match traffic for this policy rule.

mark mark_value

Specify the routing policy rule match on traffic that has been marked by the IP tables firewall with this value.

Must be an integer in the range of 1-maximum.

priority priority_value

Specify the priority for the routing policy rule to influence the order in which routing rules are processed.

Must be an integer.

table table_number

Specify the table number to use for the route.

Must be an integer in the range of 1-maximum.

to destination_ip_address

Specify to match on traffic going to the specified destination.

type-of-service type_of_service_number

Specify to match this policy rule based on the type of service number applied to the traffic.

Must be an integer.

Configures netplan bridge type.

accept-ra { false | true }

Specify whether to accept or reject the Router Advertisement that would have the kernel configure IPv6 by itself.

Must be one of the following:

• false

• true

addresses ip_address/prefix_length

Specify to add static addresses to the interface in addition to the ones received through DHCP or RA.

critical { false | true }

Designate the connection as "critical to the system", meaning that special care will be taken by systemd-networkd to not release the IP from DHCP when the daemon is restarted.

Must be one of the following:

• false

• true

device-id device_id

Specify the netplan device ID.

Must be a string.

dhcp-identifier dhcp_identifier

Assign the setting (when set to mac) over to systemd-networkd to use the device’s MAC address as a unique identifier rather than a RFC4361-compliant Client ID.

Must be a string.

dhcp4 { false | true }

Specify whether to enable or disable DHCP for IPv4.

Must be one of the following:

• false

• true

dhcp6 { false | true }

Specify whether to enable or disable DHCP for IPv6.

Must be one of the following:

• false

• true

gateway4 ipv4_address

Specify the default gateway for IPv4.

gateway6 ipv6_address

Specify the default gateway for IPv6.

interfaces interface_id

Adds all the devices matching this ID to the bridge.

Must be a string.

ipv6-privacy { false | true }

Specify whether to enable or disable IPv6 Privacy Extensions (RFC 4941) for the specified interface, and prefer temporary addresses.

Must be one of the following:

• false

• true

link-local link_local_address

Specify the link-local addresses to bring up.

Must be one of the following:

• ipv4

• ipv6

macaddress mac_address

Specify the MAC address.

mtu number_of_mtu

Specify the Maximum Transmission Unit (MTU) for the interface.

Must be an integer.

Note	It is recommended to set MTU to the lowest path MTU.

optional { false | true }

Specify whether an optional device is required for booting.

Must be one of the following:

• false

• true

renderer renderer_type

Specify to use the given networking backend for this definition.

Must be one of the following:

• NetworkManager

• networkd

Overrides the default DHCP4 behavior.

hostname host_name

Specify the host name sent to the DHCP server, instead of the machine’s host name.

Must be a string.

route-metric route_metric_value

Specify the default metric value for automatically-added routes. Use this to prioritize routes for devices by setting a higher metric on a preferred interface.

Must be an integer.

send-hostname { false | true }

Specify whether the machine’s host name will be sent to the DHCP server. When set to true, the machine’s host name will be sent to the DHCP server.

Must be one of the following:

• false

• true

use-dns { false | true }

Specify whether the DNS servers received from the DHCP server will be used, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-hostname { false | true }

Specify whether the host name received from the DHCP server will be set as the transient host name of the system.

Must be one of the following:

• false

• true

use-mtu { false | true }

Specify whether the MTU received from the DHCP server will be set as the MTU of the network interface. When set to false, the MTU advertised by the DHCP server will be ignored.

Must be one of the following:

• false

• true

use-ntp { false | true }

Specify whether the NTP servers received from the DHCP server will be used by systemd-timesyncd, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-routes { false | true }

Specify whether the routes received from the DHCP server will be installed in the routing table normally. When set to false, routes from the DHCP server will be ignored. In such a scenario, the user is responsible for adding static routes (if required) for correct network operation. This allows users to avoid installing a default gateway for interfaces configured through DHCP.

Must be one of the following:

• false

• true

Overrides the default DHCP6 behavior.

hostname host_name

Specify the host name sent to the DHCP server, instead of the machine’s host name.

Must be a string.

route-metric route_metric_value

Specify the default metric value for automatically-added routes. Use this to prioritize routes for devices by setting a higher metric on a preferred interface.

Must be an integer.

send-hostname { false | true }

Specify whether the machine’s host name will be sent to the DHCP server. When set to true, the machine’s host name will be sent to the DHCP server.

Must be one of the following:

• false

• true

use-dns { false | true }

Specify whether the DNS servers received from the DHCP server will be used, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-hostname { false | true }

Specify whether the host name received from the DHCP server will be set as the transient host name of the system.

Must be one of the following:

• false

• true

use-mtu { false | true }

Specify whether the MTU received from the DHCP server will be set as the MTU of the network interface. When set to false, the MTU advertised by the DHCP server will be ignored.

Must be one of the following:

• false

• true

use-ntp { false | true }

Specify whether the NTP servers received from the DHCP server will be used by systemd-timesyncd, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-routes { false | true }

Specify whether the routes received from the DHCP server will be installed in the routing table normally. When set to false, routes from the DHCP server will be ignored. In such a scenario, the user is responsible for adding static routes (if required) for correct network operation. This allows users to avoid installing a default gateway for interfaces configured through DHCP.

Must be one of the following:

• false

• true

Configures the DNS servers and search domains.

addresses ip_addresses

Specify the DNS server IP address.

search domain_name

Specify the search domain name.

Must be a string.

Configures types of addresses that are not required for a device to be considered online.

optional-addresses optional_addresses

Specify the address type that is required for a device to be considered online.

Must be one of the following:

• dhcp4

• dhcp6

• ipv4-ll

• ipv6-ra

• static

Configures the customization parameters for special bridging options.

ageing-time ageing_time

Specify the period of time to keep a MAC address in the forwarding database after a packet is received.

Must be a string.

forward-delay forward_delay_period

Specify the period of time the bridge will remain in Listening and Learning states before getting to the Forwarding state.

Must be a string.

hello-time hello_time_interval

Specify the interval between two hello packets being sent out from the root and designated bridges.

Must be a string.

max-age maximum_age

Specify the maximum age of a hello packet.

Must be a string.

path-cost cost_of_path

Specify the cost of a path on the bridge.

Must be a string.

post-port-priority post_port_priority_range

Specify the port priority range.

Must be an integer in the range of 0-63.

priority priority_value

Specify the priority value for the bridge.

Must be an integer.

stp { false | true }

Specify whether the bridge should use Spanning Tree protocol.

Must be one of the following:

• false

• true

Configures static routing for the device.

from source_ip_address

Specify the source IP address for traffic going through the route.

metric relative_priority_value

Specify the relative priority of the route.

Must be an integer.

on-link { false | true }

Specify whether the route is directly connected to the interface. When set to true, specifies that the route is directly connected to the interface.

Must be one of the following:

• false

• true

scope route_scope

Specify the route scope and how wide-ranging it is to the network.

Must be one of the following:

• global

• host

• link

table table_number

Specify the table number to use for the route.

Must be an integer in the range of 1-maximum.

type route_type

Specify the route type.

Must be one of the following:

• blackhole

• prohibit

• unicast

• unreachhable

via gateway_ip_address

Specify the gateway IP address to use for this route.

destination_ip_address

Specify the destination IP address for the route.

Configures policy routing for the device.

from source_ip_address

Specify the source IP address to match traffic for this policy rule.

mark mark_value

Specify the routing policy rule match on traffic that has been marked by the IP tables firewall with this value.

Must be an integer in the range of 1-maximum.

priority priority_value

Specify the priority for the routing policy rule to influence the order in which routing rules are processed.

Must be an integer.

table table_number

Specify the table number to use for the route.

Must be an integer in the range of 1-maximum.

to destination_ip_address

Specify to match on traffic going to the specified destination.

type-of-service type_of_service_number

Specify to match this policy rule based on the type of service number applied to the traffic.

Must be an integer.

Configures netplan ethernets device type.

accept-ra { false | true }

Specify whether to accept or reject the Router Advertisement that would have the kernel configure IPv6 by itself.

Must be one of the following:

• false

• true

addresses ip_address/prefix_length

Specify to add static addresses to the interface in addition to the ones received through DHCP or RA.

critical { false | true }

Designate the connection as "critical to the system", meaning that special care will be taken by systemd-networkd to not release the IP from DHCP when the daemon is restarted.

Must be one of the following:

• false

• true

device-id device_id

Specify the netplan device ID.

Must be a string.

dhcp-identifier dhcp_identifier

Assign the setting (when set to mac) over to systemd-networkd to use the device’s MAC address as a unique identifier rather than a RFC4361-compliant Client ID.

Must be a string.

dhcp4 { false | true }

Specify whether to enable or disable DHCP for IPv4.

Must be one of the following:

• false

• true

dhcp6 { false | true }

Specify whether to enable or disable DHCP for IPv6.

Must be one of the following:

• false

• true

gateway4 ipv4_address

Specify the default gateway for IPv4.

gateway6 ipv6_address

Specify the default gateway for IPv6.

ipv6-privacy { false | true }

Specify whether to enable or disable IPv6 Privacy Extensions (RFC 4941) for the specified interface, and prefer temporary addresses.

Must be one of the following:

• false

• true

link-local link_local_address

Specify the link-local addresses to bring up.

Must be one of the following:

• ipv4

• ipv6

macaddress mac_address

Specify the MAC address.

mtu number_of_mtu

Specify the Maximum Transmission Unit (MTU) for the interface.

Must be an integer.

optional { false | true }

Specify whether an optional device is required for booting.

Must be one of the following:

• false

• true

renderer renderer_type

Specify to use the given networking backend for this definition.

Must be one of the following:

• NetworkManager

• networkd

Configures the authentication parameters.

ca-certificate path_to_trusted_ca_cert_file

Specify the path to a file with one or more trusted Certificate Authority (CA) certificates.

Must be a string.

client-certificate path_to_client_cert_file

Specify the path to a file containing the certificate to be used by the client during authentication.

Must be a string.

client-key-password client_key_password

Specify the password to use to decrypt the private key specified in client-key if it is encrypted.

Must be a string.

client-key path_to_client_key_file

Specify the path to a file containing the private key corresponding to client-certificate.

Must be a string.

key-management key_management_mode

Specify the key management mode.

Must be one of the following:

• 802.1x

• none

Overrides the default DHCP4 behavior.

hostname host_name

Specify the host name sent to the DHCP server, instead of the machine’s host name.

Must be a string.

route-metric route_metric_value

Specify the default metric value for automatically-added routes. Use this to prioritize routes for devices by setting a higher metric on a preferred interface.

Must be an integer.

send-hostname { false | true }

Specify whether the machine’s host name will be sent to the DHCP server. When set to true, the machine’s host name will be sent to the DHCP server.

Must be one of the following:

• false

• true

use-dns { false | true }

Specify whether the DNS servers received from the DHCP server will be used, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-hostname { false | true }

Specify whether the host name received from the DHCP server will be set as the transient host name of the system.

Must be one of the following:

• false

• true

use-mtu { false | true }

Specify whether the MTU received from the DHCP server will be set as the MTU of the network interface. When set to false, the MTU advertised by the DHCP server will be ignored.

Must be one of the following:

• false

• true

use-ntp { false | true }

Specify whether the NTP servers received from the DHCP server will be used by systemd-timesyncd, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-routes { false | true }

Specify whether the routes received from the DHCP server will be installed in the routing table normally. When set to false, routes from the DHCP server will be ignored. In such a scenario, the user is responsible for adding static routes (if required) for correct network operation. This allows users to avoid installing a default gateway for interfaces configured through DHCP.

Must be one of the following:

• false

• true

Overrides the default DHCP6 behavior.

hostname host_name

Specify the host name sent to the DHCP server, instead of the machine’s host name.

Must be a string.

route-metric route_metric_value

Specify the default metric value for automatically-added routes. Use this to prioritize routes for devices by setting a higher metric on a preferred interface.

Must be an integer.

send-hostname { false | true }

Specify whether the machine’s host name will be sent to the DHCP server. When set to true, the machine’s host name will be sent to the DHCP server.

Must be one of the following:

• false

• true

use-dns { false | true }

Specify whether the DNS servers received from the DHCP server will be used, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-hostname { false | true }

Specify whether the host name received from the DHCP server will be set as the transient host name of the system.

Must be one of the following:

• false

• true

use-mtu { false | true }

Specify whether the MTU received from the DHCP server will be set as the MTU of the network interface. When set to false, the MTU advertised by the DHCP server will be ignored.

Must be one of the following:

• false

• true

use-ntp { false | true }

Specify whether the NTP servers received from the DHCP server will be used by systemd-timesyncd, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-routes { false | true }

Specify whether the routes received from the DHCP server will be installed in the routing table normally. When set to false, routes from the DHCP server will be ignored. In such a scenario, the user is responsible for adding static routes (if required) for correct network operation. This allows users to avoid installing a default gateway for interfaces configured through DHCP.

Must be one of the following:

• false

• true

Configures the DNS servers and search domains.

addresses ip_addresses

Specify the DNS server IP address.

search domain_name

Specify the search domain name.

Must be a string.

Configures types of addresses that are not required for a device to be considered online.

optional-addresses optional_addresses

Specify the address type that is required for a device to be considered online.

Must be one of the following:

• dhcp4

• dhcp6

• ipv4-ll

• ipv6-ra

• static

Configures static routing for the device.

from source_ip_address

Specify the source IP address for traffic going through the route.

metric relative_priority_value

Specify the relative priority of the route.

Must be an integer.

on-link { false | true }

Specify whether the route is directly connected to the interface. When set to true, specifies that the route is directly connected to the interface.

Must be one of the following:

• false

• true

scope route_scope

Specify the route scope and how wide-ranging it is to the network.

Must be one of the following:

• global

• host

• link

table table_number

Specify the table number to use for the route.

Must be an integer in the range of 1-maximum.

type route_type

Specify the route type.

Must be one of the following:

• blackhole

• prohibit

• unicast

• unreachhable

via gateway_ip_address

Specify the gateway IP address to use for this route.

destination_ip_address

Specify the destination IP address for the route.

Configures policy routing for the device.

from source_ip_address

Specify the source IP address to match traffic for this policy rule.

mark mark_value

Specify the routing policy rule match on traffic that has been marked by the IP tables firewall with this value.

Must be an integer in the range of 1-maximum.

priority priority_value

Specify the priority for the routing policy rule to influence the order in which routing rules are processed.

Must be an integer.

table table_number

Specify the table number to use for the route.

Must be an integer in the range of 1-maximum.

to destination_ip_address

Specify to match on traffic going to the specified destination.

type-of-service type_of_service_number

Specify to match this policy rule based on the type of service number applied to the traffic.

Must be an integer.

Configures the tunnel mode.

accept-ra { false | true }

Specify whether to accept or reject the Router Advertisement that would have the kernel configure IPv6 by itself.

Must be one of the following:

• false

• true

addresses ip_address/prefix_length

Specify to add static addresses to the interface in addition to the ones received through DHCP or RA.

critical { false | true }

Designate the connection as "critical to the system", meaning that special care will be taken by systemd-networkd to not release the IP from DHCP when the daemon is restarted.

Must be one of the following:

• false

• true

device-id device_id

Specify the netplan device ID.

Must be a string.

dhcp-identifier dhcp_identifier

Assign the setting (when set to mac) over to systemd-networkd to use the device’s MAC address as a unique identifier rather than a RFC4361-compliant Client ID.

Must be a string.

dhcp4 { false | true }

Specify whether to enable or disable DHCP for IPv4.

Must be one of the following:

• false

• true

dhcp6 { false | true }

Specify whether to enable or disable DHCP for IPv6.

Must be one of the following:

• false

• true

gateway4 ipv4_address

Specify the default gateway for IPv4.

gateway6 ipv6_address

Specify the default gateway for IPv6.

ipv6-privacy { false | true }

Specify whether to enable or disable IPv6 Privacy Extensions (RFC 4941) for the specified interface, and prefer temporary addresses.

Must be one of the following:

• false

• true

link-local link_local_address

Specify the link-local addresses to bring up.

Must be one of the following:

• ipv4

• ipv6

local ip_address

Specify the IP address of the local endpoint of the tunnel.

macaddress mac_address

Specify the MAC address.

mode tunnel_mode

Specify the tunnel mode.

Must be one of the following:

• gre

• gretap

• ip6gre

• ip6gretap

• ip6ip6

• ipip6

• ipip

• isatap

• sit

• vti6

• vti

mtu number_of_mtu

Specify the Maximum Transmission Unit (MTU) for the interface.

Must be an integer.

It is recommended to set MTU to the lowest path MTU.

optional { false | true }

Specify whether an optional device is required for booting.

Must be one of the following:

• false

• true

remote ip_address

Specify the IP address of the remote endpoint of the tunnel.

renderer renderer_type

Specify to use the given networking backend for this definition.

Must be one of the following:

• NetworkManager

• networkd

Overrides the default DHCP4 behavior.

hostname host_name

Specify the host name sent to the DHCP server, instead of the machine’s host name.

Must be a string.

route-metric route_metric_value

Specify the default metric value for automatically-added routes. Use this to prioritize routes for devices by setting a higher metric on a preferred interface.

Must be an integer.

send-hostname { false | true }

Specify whether the machine’s host name will be sent to the DHCP server. When set to true, the machine’s host name will be sent to the DHCP server.

Must be one of the following:

• false

• true

use-dns { false | true }

Specify whether the DNS servers received from the DHCP server will be used, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-hostname { false | true }

Specify whether the host name received from the DHCP server will be set as the transient host name of the system.

Must be one of the following:

• false

• true

use-mtu { false | true }

Specify whether the MTU received from the DHCP server will be set as the MTU of the network interface. When set to false, the MTU advertised by the DHCP server will be ignored.

Must be one of the following:

• false

• true

use-ntp { false | true }

Specify whether the NTP servers received from the DHCP server will be used by systemd-timesyncd, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-routes { false | true }

Specify whether the routes received from the DHCP server will be installed in the routing table normally. When set to false, routes from the DHCP server will be ignored. In such a scenario, the user is responsible for adding static routes (if required) for correct network operation. This allows users to avoid installing a default gateway for interfaces configured through DHCP.

Must be one of the following:

• false

• true

Overrides the default DHCP6 behavior.

hostname host_name

Specify the host name sent to the DHCP server, instead of the machine’s host name.

Must be a string.

route-metric route_metric_value

Specify the default metric value for automatically-added routes. Use this to prioritize routes for devices by setting a higher metric on a preferred interface.

Must be an integer.

send-hostname { false | true }

Specify whether the machine’s host name will be sent to the DHCP server. When set to true, the machine’s host name will be sent to the DHCP server.

Must be one of the following:

• false

• true

use-dns { false | true }

Specify whether the DNS servers received from the DHCP server will be used, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-hostname { false | true }

Specify whether the host name received from the DHCP server will be set as the transient host name of the system.

Must be one of the following:

• false

• true

use-mtu { false | true }

Specify whether the MTU received from the DHCP server will be set as the MTU of the network interface. When set to false, the MTU advertised by the DHCP server will be ignored.

Must be one of the following:

• false

• true

use-ntp { false | true }

Specify whether the NTP servers received from the DHCP server will be used by systemd-timesyncd, and will take precedence over any that are statically configured.

Must be one of the following:

• false

• true

use-routes { false | true }

Specify whether the routes received from the DHCP server will be installed in the routing table normally. When set to false, routes from the DHCP server will be ignored. In such a scenario, the user is responsible for adding static routes (if required) for correct network operation. This allows users to avoid installing a default gateway for interfaces configured through DHCP.

Must be one of the following:

• false

• true

Configures the keys to use for the tunnel.