The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Validates the cluster configuration.
Security Administrator, Administrator
Exec > Global Configuration
validate-cluster { logs | run log-level log_level } Use this command to validate the cluster configuration.
Displays the cluster configuration logs.
Security Administrator, Administrator
Exec > Global Configuration
logs Use this command to view the cluster configuration logs.
Runs the cluster validation.
Security Administrator, Administrator
Exec > Global Configuration
run log-level log_level Specify the log-level.
Must be one of the following:
CRITICAL: Critical.
ERROR: Error.
WARNING: Warning.
INFO: Info.
DEBUG: Debug.
Default Value: INFO.
Use this command to run the cluster validation.
Displays overall status of the cluster including pod and etcd based statistics.
Security Administrator, Administrator
Exec > Global Configuration
k8s cluster-status Use this command to view the overall status of the cluster including pod and etcd based statistics.
Displays the cluster synchornization logs.
Security Administrator, Administrator
Exec > Global Configuration
logs Use this command to display the cluster synchronization.
Displays the TCP, UDP, NTP and log-level information of the clusters.
Security Administrator, Administrator
Exec > Global Configuration
show { info { log-level log_level | ntp-info [ false | true ] | tcp-connections [ false | true ] | udp-connections [ false | true ] } | logs } Use this command to view the TCP, UDP, NTP and log-level information of the clusters.
Displays the clusters TCP, UDP, NTP and log-level information.
Security Administrator, Administrator
Exec > Global Configuration
info { log-level log_level | ntp-info [ false | true ] | tcp-connections [ false | true ] | udp-connections [ false | true ] } Displays the TCP Services and connections.
Must be either "false" or "true".
Default Value: true.
Displays the UDP services and connections.
Must be either "false" or "true".
Default Value: true.
Displays the NTP clock server information.
Must be either "false" or "true".
Default Value: true.
Displays the log level.
Must be one of the following:
CRITICAL
ERROR
WARNING
INFO
DEBUG
Default Value: INFO.
Use this command to view the clusters TCP, UDP, NTP and log-level information.
Displays the cluster configuration logs.
Security Administrator, Administrator
Exec > Global Configuration
logs Use this command to view the cluster configuration.
Cancels cluster synchronization
Security Administrator, Administrator
Exec > Global Configuration
cancel Use this command to cancel cluster synchronization.
Synchronizes the cluster configurations.
Security Administrator, Administrator
Exec > Global Configuration
sync { cancel | logs | run { debug | force-vm-redeploy | purge-data-disks | reset-k8s-nodes | upgrade-strategy { concurrent | rolling } } | status } Use this command to synchronize the cluster configurations.
Runs the cluster synchronization.
Security Administrator, Administrator
Exec > Global Configuration
run { debug | force-vm-redeploy | purge-data-disks | reset-k8s-nodes | upgrade-strategy { concurrent | rolling } } Specify the upgrade strategy.
Must be one of the following:
rolling
concurrent
auto
Default Value: auto.
Specify whether to redeploy the VM or not.
Must be either "false" or "true".
Default Value: false.
Force redeploying the partition.
Must be either "false" or "true".
Default Value: false.
Specfies whether to debug or not.
Must be either "false" or "true".
Default Value: false.
Specify whether to reset the K8s nodes or not.
Must be either "false" or "true".
Default Value: false.
Specify whether to purge data disks or not.
Must be either "false" or "true".
Default Value: false.
Specify the synchorinization phase.
Must be one of the following:
all
opscenter
distributed-registry
Default Value: all.
Specify the ansible startegy for the synchorinization.
Must be one of the following:
linear
free
Default Value: linear.
Use this command to run the cluster synchronization.
Displays the cluster synchronization status.
Security Administrator, Administrator
Exec > Global Configuration
status Use this command to view the cluster synchronization status.
Validates the configuration defined for the clusters.
Security Administrator, Administrator
Exec > Global Configuration
validate-config { logs | run { k8s-node-checks [ false | true ] | log-level log-level log_level | netplan [ false | true ] | ntp [ false | true ] | proxy [ false | true ] | ssh [ false | true ] | vmware-checks [ false | true ] } } Use this command to validate the configuration defined for the clusters.
Displays the cluster configuration logs.
Security Administrator, Administrator
Exec > Global Configuration
logs Use this command to view the cluster configuration logs.
Runs the cluster configuration validation.
Security Administrator, Administrator
Exec > Global Configuration
run { k8s-node-checks [ false | true ] | log-level log-level log_level | netplan [ false | true ] | ntp [ false | true ] | proxy [ false | true ] | ssh [ false | true ] | vmware-checks [ false | true ] } Validates the netplan configuration.
Must be either "false" or "true".
Default Value: true.
Validates the SSH configuration.
Must be either "false" or "true".
Default Value: true.
Validates the NTP server configuration.
Must be either "false" or "true".
Default Value: true.
Validates the proxy server configuration.
Must be either "false" or "true".
Default Value: true.
Validates the vcenter, datastore and host configuration before synchronzing.
Must be either "false" or "true".
Default Value: true.
Validates the K8s nodes configuration size.
Must be either "false" or "true".
Default Value: true.
Specify the log-level.
Must be one of the following:
CRITICAL
ERROR
WARNING
INFO
DEBUG
Default Value: INFO.
Use this command to run the cluster configuration validation.
Configures the basic kubernetes cluster functionality.
Security Administrator, Administrator
Exec > Global Configuration
addons { ingress { bind-ip-address ipv4_address | disabled bind-ip-address ipv4_address | enabled bind-ip-address ipv4_address } | istio { disabled | enabled } | kubernetes-dashboard { enabled | diabled } | network type calico | openstack-volume-provider { auth-url url | domain-id domain_id | password string | tenant-id tenant_id | username username } } Use this command to implement kubernetes basic functionality like Ingress and other functionality expected to be provided by the kubernetes cluster.
Enables or disables the CPU partitioning.
Security Administrator, Administrator
Exec > Global Configuration
cpu-partitioner { enabled | disabled } Specify to enable or disable CPU partitioning.
Must be either "false" or "true".
Default Value: false.
Use this command to enable or disable CPU partitioning.
Enables or disables the distributed registry.
Security Administrator, Administrator
Exec > Global Configuration
distributed-registry { enabled | disabled | releases name } Specify to enable or disable the distributed-registry.
Must be either "false" or "true".
Default Value: false.
Use this command to enable or disable the distributed registry.
Specify the release name whose chart and images need to be added to the registry.
Security Administrator, Administrator
Exec > Global Configuration
releases name Specify the release name.
Must be a string.
Use this command to specify the release name whose chart and images need to be added to the registry.
Configures the ingress IPv4 address.
Security Administrator, Administrator
Exec > Global Configuration
ingress service-type { bind-ip-address ipv4_address | disabled bind-ip-address ipv4_address | enabled bind-ip-address ipv4_address } Specify the IPv4 address for binding.
Specify to enable or disable.
Must be either "false" or "true".
Default Value: true.
Specify the failure-threshold.
Must be an integer.
Default Value: 3.
Specify the timeout in seconds.
Must be an integer.
Default Value: 1.
Use this command to configure the ingress IPv4 address to Kubernetes cluster.
Enables or Disbales the Istio services.
Security Administrator, Administrator
Exec > Global Configuration
isitio { enabled | disabled } Specify to enable or disable the Istio services.
Must be either "false" or "true".
Default Value: false.
Use this command to enable or disable the Istios services.
Configures the Kubernetes dashboard.
Security Administrator, Administrator
Exec > Global Configuration
kubernetes-dashboard enabled { false | true } Specify to enable or disable the Kubernetes dashboard.
Must be either "false" or "true".
Default Value: false.
Use this command to configure the Kubernetes dashboard.
Configures the network type.
Security Administrator, Administrator
Exec > Global Configuration
network type calico Specify the network type. The default type is Calico.
Must be one of the following:
calico
Default Value: calico.
Use this command to configure the network type.
Enables the OpenStack volume provider.
Security Administrator, Administrator
Exec > Global Configuration
openstack-volume-provider { auth-url url | domain-id domain_id | password password | tenant-id tenant_id | username user_name } Specify the Openstack user name.
Must be a string.
Specify the OpenStack password.
Must be an aes-cfb-128-encrypted string.
Specify the auth URL.
Must be a string.
Specify the tenant ID.
Must be a string.
Specify the domain ID.
Must be a string.
Use this command to enable the OpenStack volume provider.
Consfigures vCenter vSphere.
Security Administrator, Administrator
Exec > Global Configuration
vsphere-volume-provider { server vcenter_server | server-port vcenter_port | allow-insecure { false | true } | user vcenter_username | password vcenter_password | datacenter vcenter_datacenter | datastore vcenter_datastor | network network_id | folder cluster_folder } Specify the vCenter server name.
Must be a string.
Specify the vCenter server port.
Must be an integer.
Default Value: 443.
Specify to allow or deny self-signed certificates.
Must be either "false" or "true".
Default Value: false.
Specify the vCenter user name.
Must be a string.
Specify the vCenter password.
Must be an aes-cfb-128-encrypted string.
Specify the vCenter datacenter.
Must be a string.
Specify the vCenter datastore.
Must be a string.
Specify the vCenter network ID.
Must be a string.
Specify the cluster folder containing the VMs.
Must be a string.
Use this command to configure the vCenter vSphere.
Configures the cluster environment.
Security Administrator, Administrator
Exec > Global Configuration
clusters environment Specify the environment used to deploy.
Specify the name used to uniquely identify the cluster. Must be an alphanumeric string, and can contain the hyphen (-). It must not start with a hyphen.
Must be a string.
Use this command to configure clusters enviroment.
Configures the kubernetes cluster.
Security Administrator, Administrator
Exec > Global Configuration
configuration { additional-master-virtual-ip ipv4_address | additional-master-virtual-ip-cidr integer | addtional-master-virtual-ip-interface string | customization-image string | allow-insecure-registry { false | true } | master-virtual-ip ipv4_address | master-virtual-ip-cidr integer | master-virtual-ip-interface string | pod-subnet string | size { functional-test-aio | functional-test-ha | production} | virtual-ip-vrrp-router-id integer } Specify the virtual IPv4 address used to make the kubernetes masters Highly Available (HA).
Specify the CIDR notation of the additional master virtual IP.
Default Value: 32.
Must be an integer in the range of 0-32.
Specify the Ethernet interface to which the master IP will be assigned.
Default Value: "ens192".
Must be a string.
Specify the authentication password for Keepalived.
Must be an aes-cfb-128-encrypted string.
Default Value: "4be37dc3b4c90194d1600c483e10ad1d".
Specfies the virtual IPv4 used to provide additional access to the HA kubernetes masters. This must be set on initial cluster creation.
Specfies the CIDR notation (netmask) of additional master virtual IP.
Default Value: 32.
Must be an integer in the range of 0-32.
Specify the ethernet interface to which the additional master IP will be assigned. This will correspond to netplan network IDs
Default Value: "ens192".
Must be a string.
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.
Enters the pod subnet to configure k8s and calico.
Default Value: "192.168.0.0/16".
Must be a string.
Specify the Docker image to use for customizing the VMs deployed in the cluster.
Must be a string.
Specify the cluster size.
Must be one of the following:
production
functional-test-ha
functional-test-aio
Default Value: production.
Allows the use of insecure docker and helm registries.
Must be either "false" or "true".
Default Value: false.
Use this command to configure the kubernetes cluster.
Updates the default docker bridge network address pools.
Security Administrator, Administrator
Exec > Global Configuration
clusters configuration docker-address-pools docker_bridge_address_pool_name{ base ip_address/prefix_length | size pool_size } Specify the name of docker bridge address pool.
Specify the docker bridge IP address and subnet.
Specify the size of the address pool.
Default Value: 24
Must be an integer in the range of 8-24 (multiples of 8).
Use this command to update the default docker bridge network address pools.
The following example updates the default docker bridge network address pools.
SMI Cluster Manager(config)# clusters cluster1 pool1
SMI Cluster Manager(config-docker-address-pools-pool1)# base 192.50.0.0/16
SMI Cluster Manager(config-docker-address-pools-pool1)# size 24
SMI Cluster Manager(config-docker-address-pools-pool1)# exit Configures the cluster environment.
Security Administrator, Administrator
Exec > Global Configuration
clusters environment Specify the environment used to deploy.
Specify the name used to uniquely identify the cluster. Must be an alphanumeric string, and can contain the hyphen (-). It must not start with a hyphen.
Must be a string.
Use this command to configure clusters environment.
Configures the cloud-init configurations.
Security Administrator, Administrator
Exec > Global Configuration
initial-boot { default-user default_user | default-user-password password | default-user-ssh-public-key ssh_public_key } Specify the default user when this node is created.
Must be a string.
Specify the default SSH public key.
Must be a string.
Specify the password.
Must be an aes-cfb-128-encrypted string.
Use this command to configure the cloud-init configurations (only first boot of VM).
Configures OS-specific configurations.
Security Administrator, Administrator
Exec > Global Configuration
os { ntp | proxy { http-proxy http_proxy | https-proxy https_proxy | no-proxy no_proxy } } Use this command to configure OS-specific configurations.
Configures the affinity to a processor socket.
Security Administrator, Administrator
Exec > Global Configuration
numa-node-affinity cpu_socket_number Specify the physical CPU socket number.
Must be an integer in the range of 0-15.
Use this command to configure affinity to a processor socket.
Configures VMware parameters.
Security Administrator, Administrator
Exec > Global Configuration
performance { cpu-reservation { false | true } | latency-sensitivity latency_sensitivity | memory-reservation { false | true } } Specify the latency-senstivity.
Must be one of the following:
high: High.
low: Low.
medium: Medium.
normal: Normal.
Memory reservation info.
Must be either "false" or "true".
CPU reservation info.
Must be either "false" or "true".
Use this command to configure the VMware parameters.
Configures Kubernetes-specific configurations.
Security Administrator, Administrator
Exec > Global Configuration
k8s { node-labels key value | ssh-connection-password password | ssh-connection-private-key private_key | ssh-username user_name } Specify the SSH username used for connecting to the node.
Must be a string.
Specify the SSH private key used for connecting to the node.
Must be an aes-cfb-128-encrypted string.
Use this command to configure Kubernetes-specifc configurations.
Configures the default configuration that applies to all nodes. All options are overridable at the node level.
Security Administrator, Administrator
Exec > Global Configuration
node-defaults { initial-boot | k8s | netplan | os | vmware } Specify the SSH username used for connecting to the node.
Must be a string.
Specify the SSH private key used for connecting to the node.
Must be an aes-cfb-128-encrypted string.
Use this command to configure the default configuration that applies to all nodes. All options are overridable at the node level.
Configures the initial boot options for the node.
Security Administrator, Administrator
Exec > Global Configuration
initial-boot { default-user user | default-user-password password | default-user-ssh-public-key ssh_public_key } Specify the default user when this node is created.
Must be a string.
Specify the default SSH public key.
Must be a string.
Specify the password.
Must be an aes-cfb-128-encrypted string.
Use this command to configure the initial boot options for the node. Cloud-init configurations which only take effect on initial boot of OS and will not cause respin without other changes.
Configures Kubernetes-specific configurations.
Security Administrator, Administrator
Exec > Global Configuration
k8s { node-labels key value | ssh-connection-password password | ssh-connection-private-key private_key | ssh-username username } Specify the SSH username used for connecting to the node.
Must be a string.
Specify the SSH private key used for connecting to the node.
Must be an aes-cfb-128-encrypted string.
Use this command to configure Kubernetes-specifc configurations.
Configures netplan.
Security Administrator, Administrator
Exec > Global Configuration
netplan template template Specify the netplan YAML template used for defining network configurations.
Must be a string.
Use this command to configure netplan template.
Configures the variables that can be input into netplan template.
Security Administrator, Administrator
Exec > Global Configuration
variable-definitions name name default-value default_value Specify the variable name.
Must be a string.
Specify the variable's default value.
Must be a string.
Use this command to configure the variables that can be input into netplan template.
Configures the variables that can be input into netplan template.
Security Administrator, Administrator
Exec > Global Configuration
variable-definitions name name default-value default_value Specify the variable name.
Must be a string.
Specify the variable's default value.
Must be a string.
Use this command to configure the variables that can be input into netplan template.
Configures node labels.
Security Administrator, Administrator
Exec > Global Configuration
node-lables key value Specify the prefix for the node label. Must be an alphanumeric value in the format a-zA-Z0-0 and can contain the _ - . characters.
Must be a string.
Specify the suffix for the node label. Must be an alphanumeric value in the format a-zA-Z0-0 and can contain _-. characters. Spaces are not allowed.
Must be a string.
Use this command to configure node labels.
Configures the nodes for both OS and Kubernetes management.
Security Administrator, Administrator
Exec > Global Configuration
nodes node_name Specify machines for both OS and Kubernetes management.
Specify the name of the node. name can be an alphanumeric string containing the hyphen (-). A hostname cannot start with a hyphen. For example, Example: kashaio-123.
Must be a string.
Use this command to configure the nodes for both OS and Kubernetes management.
Runs node synchornizations.
Security Administrator, Administrator
Exec > Global Configuration
actions { k8s pod-status show-pod-details { false | true } | sync { cancel | drain | logs | run { debug { false | true } | force-vm-redeploy { false | true } | purge-data-disks { false | true } | reset-k8s-nodes { false | true } } | status } } Use this command to run node synchornizations.
Displays the status of the k8s pods in the nodes.
Security Administrator, Administrator
Exec > Global Configuration
k8s pod-status show-pod-details { false | true } Use this command to view the status of the pods in the nodes.
Configures displaying the status of the pods scheduled on the node.
Security Administrator, Administrator
Exec > Global Configuration
pod-status show-pod-details { false | true } Specify whether to display the list of pods in addition to the counts.
Must be either "false" or "true".
Default Value: false.
Use this command to configure displaying the status of the pods scheduled on the node.
Removes the node configuration.
Security Administrator, Administrator
Exec > Global Configuration
cancel Use this command to remove the node configuration.
Configures to synchorinze only one node.
Security Administrator, Administrator
Exec > Global Configuration
sync { cancel | drain { remove-node { false | true } | ansible-strategy { free | linear } } | logs | run { debug { false | true } | force-vm-redeploy { false | true } | purge-data-disks { false | true } | reset-k8s-nodes { false | true } } | status | serial-logs } Use this command to to synchorinze only one node. Typically needed for manual upgrade cases where cluster rolling upgrade is not used.
Drains the node in preparation for an upgrade.
Security Administrator, Administrator
Exec > Global Configuration
drain { remove-node { false | true } | ansible-strategy { free | linear } } Removes the specified node.
Must be either "false" or "true".
Default Value: false.
Specify the ansible startegy used for synchorinization.
Must be one of the following:
linear
free
Default Value: free.
Use this command to drain the node in preparation for an upgrade.
Displays the node configuration logs.
Security Administrator, Administrator
Exec > Global Configuration
logs Use this command to view the node configuration logs.
Upgrades the nodes.
Security Administrator, Administrator
Exec > Global Configuration
run { debug { false | true } | force-vm-redeploy { false | true } | purge-data-disks { false | true } | reset-k8s-nodes { false | true } } Specify whether to redeploy the VM or not.
Must be either "false" or "true".
Default Value: false.
Force redeploying the partition.
Must be either "false" or "true".
Default Value: false.
Specfies whether to debug or not.
Must be either "false" or "true".
Default Value: false.
Specify whether to reset the K8s nodes or not.
Must be either "false" or "true".
Default Value: false.
Specify whether to purge data disks or not.
Must be either "false" or "true".
Default Value: false.
Specify the synchorinization phase.
Must be one of the following:
all
opscenter
distributed-registry
Default Value: all.
Specify the ansible startegy for the synchorinization.
Must be one of the following:
linear
free
Default Value: linear.
Use this command to upgrade the nodes.
Displays the node configuration serial logs.
Security Administrator, Administrator
Exec > Global Configuration
serial-logs Use this command to view the node configuration serial logs.
Displays the status of the node.
Security Administrator, Administrator
Exec > Global Configuration
status Use this command to display the status of the node.
Configures the cluster specific configuration.
Security Administrator, Administrator
Exec > Global Configuration
k8s {node-ip node_ip | node-labels key value| node-type type | ssh-connection-private-key AES_encrypted_string | ssh-ip ssh_ip | ssh-username ssh_username | ssh-bind-to-ssh-ip {false | true} } Specify the Kubernetes node type.
Must be one of the following:
master
worker
etcd
Default Value: worker.
Specfies the hostname or IP address used to connect through SSH for node management.
Must be a string.
Specify if the SSHD should only listen on SSH IP.
Must be either "false" or "true".
Default Value: false.
Specify the node IP used by kubernetes for inter-node communication.
Must be a string.
Specify the SSH username used for connecting to the node.
Must be a string.
Specify the SSH private key used for connecting to the node.
Must be an aes-cfb-128-encrypted string.
Use this command to configure cluster specific configuration.
Configures the netplan template.
Security Administrator, Administrator
Exec > Global Configuration
netplan variables variable_name value value Use this command to configure the netplan template.
Displays a preview of netplan YAML and validates it with "netplan generate".
Security Administrator, Administrator
Exec > Global Configuration
actions preview-netplan Use this command to displays a preview of netplan YAML and validates it with 'netplan generate'. This command is used for debugging. It shows only the committed data.
Configures the netplan template variables.
Security Administrator, Administrator
Exec > Global Configuration
variables variable_name Specify the variable name from the netplan template.
Specify the variable value.
Must be a string.
Use this command to configure the netplan template variable.
Enables or disables JournalID rate limiting.
Security Administrator, Administrator
Exec > Global Configuration
disable-log-ratelimit enabled { false | true } Specify to enable or disable JournalID rate limiting.
Must be either "false" or "true".
Use this command to enable or disable JournalD rate limiting.
Allows adding to netplan configuration from initial-boot (cloud-init). NOTE: currently only routes are supported and not all netplan fields are available.
Security Administrator, Administrator
Exec > Global Configuration
netplan-additions Use this command to add netplan configuration from initial-boot. At present only routes are supported and not all netplan fields are available.
Displays a preview of netplan YAML and validates with "netplan generate". This command displays only the commited data and it is useful for debugging.
Security Administrator, Administrator
Exec > Global Configuration
preview-netplan Use this command to preview the netplan.
Configures netplan bonds device type. See https://netplan.io/reference#properties-for-device-type-bonds.
Security Administrator, Administrator
Exec > Global Configuration
bonds Specify the netplan device ID. Must be unique throughout the entire set of configuration files. Their primary purpose is to serve as anchor names for composite devices, for example to enumerate the members of a bridge that is currently being defined. See: https://netplan.io/reference#device-configuration-ids
Must be a string.
Use this command to configure netplan bonds device type.
Configures netplan routes. This command defines the standard static routes for an interface. It is mandatory to specify values for to and via. See https://netplan.io/reference#routing.
Security Administrator, Administrator
Exec > Global Configuration
routes to destination_address via gateway_address from source_ip_address metric metric_value Specify the destination address. Must be a string in 'x.x.x.x/x' or 'x.x.x.x' format.
Must be a string.
Specify the gateway address. Must be a string in 'x.x.x.x/x' or 'x.x.x.x' format.
Must be a string.
Specify the source IP address going through the route.
Must be a string.
Specify the relative priority of the route.
Must be a string.
Use this command to configure netplan routes.
Configures netplan ethernets device type. See https://netplan.io/reference#properties-for-device-type-ethernets.
Security Administrator, Administrator
Exec > Global Configuration
ethernets Specify the netplan device ID. Must be unique throughout the entire set of configuration files. Their primary purpose is to serve as anchor names for composite devices, for example to enumerate the members of a bridge that is currently being defined. See: https://netplan.io/reference#device-configuration-ids
Must be a string.
Use this command to configure netplan ethernets device type.
Configures netplan routes. This command defines the standard static routes for an interface. It is mandatory to specify values for to and via. See https://netplan.io/reference#routing.
Security Administrator, Administrator
Exec > Global Configuration
routes to destination_address via gateway_address from source_ip_address metric metric_value Specify the destination address. Must be a string in 'x.x.x.x/x' or 'x.x.x.x' format.
Must be a string.
Specify the gateway address. Must be a string in 'x.x.x.x/x' or 'x.x.x.x' format.
Must be a string.
Specify the source IP address going through the route.
Must be a string.
Specify the relative priority of the route.
Must be a string.
Use this command to configure netplan routes.
Configures netplan vlan device type. See https://netplan.io/reference#properties-for-device-type-vlans
Security Administrator, Administrator
Exec > Global Configuration
vlans Specify the netplan device ID. Must be unique throughout the entire set of configuration files. Their primary purpose is to serve as anchor names for composite devices, for example to enumerate the members of a bridge that is currently being defined. See: https://netplan.io/reference#device-configuration-ids
Must be a string.
Use this command to configure netplan vlan device type.
Configures netplan routes. This command defines the standard static routes for an interface. It is mandatory to specify values for to and via. See https://netplan.io/reference#routing.
Security Administrator, Administrator
Exec > Global Configuration
routes to destination_address via gateway_address from source_ip_address metric metric_value Specify the destination address. Must be a string in 'x.x.x.x/x' or 'x.x.x.x' format.
Must be a string.
Specify the gateway address. Must be a string in 'x.x.x.x/x' or 'x.x.x.x' format.
Must be a string.
Specify the source IP address going through the route.
Must be a string.
Specify the relative priority of the route.
Must be a string.
Use this command to configure netplan routes.
Configures the NTP servers for the nodes.
Security Administrator, Administrator
Exec > Global Configuration
ntp { disabled | enabled servers url | servers url } Enables the NTP servers for configuration.
Must be either "false" or "true".
Use this command to configure the NTP servers for the nodes.
Configures the time server parameters.
Security Administrator, Administrator
Exec > Global Configuration
servers url { key-id key_id | sha-key sha_key | sha-type sha_type } Specify the NTP server url. For example, clock.cisco.com.
Must be a string.
Spcify the key-id for the chrony server keys.
Must be a string.
Specify the type of SHA for the Chrony server keys. For instance, SHA1, SHA256, SHA512 etc. See: https://chrony.tuxfamily.org/manual.html.
Must be one of the following:
SHA1
SHA256
SHA384
SHA512
RMD128
RMD160
RMD256
RMD320
TIGER
WHIRLPOOL
Specify the SHA authentication key with Chrony server.
Must be a string.
Use this command to configure time server parameters, which need to be input into the NTP configuration.
Configures the proxy servers at the node level.
Security Administrator, Administrator
Exec > Global Configuration
proxy { http-proxy http_proxy | https-proxy https_proxy | no-proxy no_proxy } Specify to send HTTP traffic to an HTTP proxy.
Must be a string.
Specify to send HTTPS traffic to an HTTP proxy.
Must be a string.
Specify the hosts to avoid proxy.
Must be a string.
Use this command to configure the proxy servers at the node level.
Enable or disable.
Security Administrator, Administrator
Exec > Global Configuration
tuned { disabled | enabled } Enable or disable.
Must be either "false" or "true".
Use this command to enable or disable.
Configures the default configuration that applies to all nodes of a specific type. Takes precedence over node-defaults. All options are overridable at the node level.
Security Administrator, Administrator
Exec > Global Configuration
node-type-defaults type Specify the node type.
Must be one of the following:
master
worker
etcd
Use this command to configure the default configuration that applies to all nodes of a specific type. Takes precedence over node-defaults. All options are overridable at the node level.
Configures the cloud-init configurations, which only take effect on initial boot of OS and will not cause respin without other changes.
Security Administrator, Administrator
Exec > Global Configuration
initial-boot { default-user user | default-user-password password | default-user-ssh-public-key ssh_public_key } Specify the default user when this node is created.
Must be a string.
Specify the default SSH public key.
Must be a string.
Specify the password.
Must be an aes-cfb-128-encrypted string.
Use this command to configure the cloud-init configurations, which only take effect on initial boot of OS and will not cause respin without other changes.
Configures Kubernetes-specific configurations.
Security Administrator, Administrator
Exec > Global Configuration
k8s { node-labels key value | ssh-connection-password password | ssh-connection-private-key private_key| ssh-username user_name } Specify the SSH username used for connecting to the node.
Must be a string.
Specify the SSH private key used for connecting to the node.
Must be an aes-cfb-128-encrypted string.
Use this command to configure Kubernetes-specific configurations.
Configures Kubernetes-specific configurations.
Security Administrator, Administrator
Exec > Global Configuration
k8s { node-labels key value | ssh-connection-password password | ssh-connection-private-key private_key | ssh-username username } Specify the SSH username used for connecting to the node.
Must be a string.
Specify the SSH private key used for connecting to the node.
Must be an aes-cfb-128-encrypted string.
Use this command to configure Kubernetes-specific configurations.
Configures node labels.
Security Administrator, Administrator
Exec > Global Configuration
node-lables key value. Specify the prefix for the node label. Must be a alphanumeric string, and contain capital letters, and the underscore (_), hyphen (-), and dot (.) characters.
Must be a string.
Specify the suffix for the node label. Must be a alphanumeric string, and can contain capital letters, the underscore (_), hypen (-) and dot (.) characters. Spaces are not allowed.
Must be a string.
Use this command to configure node labels.
Configures netplan.
Security Administrator, Administrator
Exec > Global Configuration
netplan template template Specify the netplan YAML template used for defining network configurations.
Must be a string.
Use this command to configure netplan template.
Allows installation of application Ops centers used to install and manage applications.
Security Administrator, Administrator
Exec > Global Configuration
ops-centers app_name instance { repository url | netconf-ip ipv4_address | netconf-port port_number | ssh-ip ipv4_address | ssh-port port_number | ingress-hostname ip_address.nip.io } Specify the app name of the Ops center. For example, cee, ccmts. Chart name will be app-name-ops-center.
Must be a string.
Specify the name of the instance. For example, data, infra etc.
Must be a string.
Specify the product chart repository URL.
Specify the username to login to the repository.
Must be a string.
Specify the password to login to the repository.
Must be an aes-cfb-128-encrypted string.
Synchronizes the default helm repository to ops-center.
Must be either "false" or "true".
Default Value: true.
Specify the Netconf IPv4 address for the Ops Center.
Specify the Netconf port number for the Ops Center.
Must be an integer.
Default Value: 830.
Specify the SSH IP address for the Ops Center.
Specify the SSH port number for the Ops Center.
Must be an integer.
Default Value: 2022.
Specify the ingress hostname to be set to the Ops Center. Uses the ip-address .nip.io format.
Must be a string.
Use this command to allow installation of application Ops centers used to install and manage applications.
Configures the initial boot parameters for helm chart deployment.
Security Administrator, Administrator
Exec > Global Configuration
initial-boot-parameters { use-volume-claims { false | true } | first-boot-password password | auto-deploy { false | true } | single-node { false | true } | image-pull-secrets name } Specify the usage of persistent volumes. To use persistent volumes, set to true.
Must be either "false" or "true".
Default Value: false.
Use this command to configure the initial boot parameters for helm chart deployment.
Configures the docker registry secret name.
Security Administrator, Administrator
Exec > Global Configuration
image-pull-secrets secret_name Specify the docker registry secret name.
Must be a string.
Must be an aes-cfb-128-encrypted string.
Default Value: "p@ssw0rd".
Must be either "false" or "true".
Default Value: true.
Specify whether to deploy the product chart on a single node. For multi-node deployments, set to false.
Must be either "false" or "true".
Default Value: true.
Use this command to configure the docker registry secret name.
Configures the initial boot parameters for helm chart deployment.
Security Administrator, Administrator
Exec > Global Configuration
initial-boot-parameters { use-volume-claims { false | true } | first-boot-password password | auto-deploy { false | true } | single-node { false | true } | image-pull-secrets name } Specify the usage of persistent volumes. To use persistent volumes, set to true.
Must be either "false" or "true".
Default Value: false.
Must be an aes-cfb-128-encrypted string.
Default Value: "p@ssw0rd".
Must be either "false" or "true".
Default Value: true.
Specify whether to deploy the product chart on a single node. For multi-node deployments, set to false.
Must be either "false" or "true".
Default Value: true.
Use this command to configure the initial boot parameters for helm chart deployment.
Configures the docker registry secret name.
Security Administrator, Administrator
Exec > Global Configuration
image-pull-secrets secret_name Specify the docker registry secret name.
Must be a string.
Use this command to configure the docker registry secret name.
Configures the Kuberentes cluster-wide secrets.
Security Administrator, Administrator
Exec > Global configuration
secrets { tls { namespace namespace secret-name name { private-key string | certificate path_to_cert } } | docker-registry secret-name { docker-server server_name | docker-username user_name | docker-password password | docker-email email | namespace namespace } } Use this command to configure the cluster-wide secrets.
Configures the name of the registry secret.
Security Administrator, Administrator
Exec > Global Configuration
docker-registry secret_name { docker-server server_name | docker-username user_name | docker-password password | docker-email email | namespace namespace } Specify name of the secret. For example, regcred.
Must be a string.
Specify the name of the docker-server. For example, regcred.
Must be a string.
Specify the docker registry user name.
Must be a string.
Specify the docker registry password.
Must be a string.
Specify the docker registry email address.
Must be a string.
Specify the docker registry namespace.
Must be a string.
Use this command to configure the name of the registy secret.
Configures the TLS associated secret.
Security Administrator, Administrator
Exec > Global Configuration
tls { namespace namespace secret-name name { private-key string | certificate path_to_cert } } Specify the Kubernetes namespaces to create secret.
Must be a string.
Specify the name of the secret. For example, cert-grafana-ingress.
Must be a string.
Specify the private-key associated with the certificate.
Must be a string.
Specify the path to the PEM encoded public key certificate.
Must be a string.
Use this command to configure TLS associated secret.
Configures virtual IPs within the k8s cluster.
Security Administrator, Administrator
Exec > Global Configuration
virtual-ips vip_group { check-port port_number | hosts host_name priority priority_number | vrrp-interface name | vrrp-router-id router_id | ipv4-addresses ipv4_address { mask netmask | broadcast ip_address | device interface_name } | ipv6-addresses ipv6_address {device device_name | mask netmask } } Specify the logical grouping of virtual IPs. This will set the VRRP instance. vip_group can be an alphanumeric string of 0-8 characters.
Must be a string in the pattern "[a-z][0-9a-z]*".
Specify the check-port number. Set it to true to check if a localhost is listening on the expected port. If the port is not listening, the VRRP instance (or synch group) should not be up. This only applies to certain use cases - typically where an application is utilizing host networking and providing a service over this port.
Must be an integer in the range of 1-65535.
Specify the host interface name that this VRRP instance is bound to.
Must be a string.
Specify the VRRP router ID. Must be an integer in the range of 1-255. 51 is reserved.
Must be an integer.
Use this command to configure virtual IPs within the k8s cluster.
Configures the host addresses.
Security Administrator, Administrator
Exec > Global Configuration
hosts hostname priority priority Specify the host name to run the logical VIP group.
Specify the priority of the host.
Must be an integer in the range of 1-100.
Default Value: 50.
Use this command to configure the host address.
Configures virtual IPv4 addresses.
Security Administrator, Administrator
Exec > Global Configuration
ipv4-addresses ipv4_address { mask netmask | broadcast ipv4_address | device interface_name } Specify the IPv4 address.
Specify the mask value.
Must be an integer in the range of 1-32.
Specify the broadcast IPv4 address.
Specify the device to attach to the virtual IP.
Must be a string.
Use this command to configure the virtual IPv4 addresses.
Configures the IPv6 addresses.
Security Administrator, Administrator
Exec > Global Configuration
ipv6-addresses ipv6_address { device device_name | mask netmask } Specify the IPv6 addresses.
Specify the netmask.
Must be an integer in the range of 1-128.
Specify the device name attached to the VIP.
Must be a string.
Use this command to configure the IPv6 address.
Configures environment available for clusters.
Security Administrator, Administrator
Exec > Global Configuration
environments name { vcenter { allow-self-signed-cert { false | true } | cluster string | datacenter string | datastore string | host string | nics network-name | password password | port port | server url | user user_name } | manual } Specify the name of the datastore.
Must be a string.
Specify the name of the vCenter datacenter.
Must be a string.
Specify the default host used to deploy the VMs.
Must be a string.
Use this command to configure the environment available for clusters.
Allows generating artifacts to be deployed manually.
Security Administrator, Administrator
Exec > Global Configuration
manual Use this command to generate artifacts to be deployed manually.
Deploys using the vCenter API.
Security Administrator, Administrator
Exec > Global Configuration
vcenter { allow-self-signed-cert { false | true } | cluster string | datacenter string |datastore string | host string | nics network-name | password password | port port_number | server url| user user_name } Specify the IP or domain name of vCenter or ESXi host.
Must be a string.
Specify the port number of vCenter or ESXi host.
Must be an integer.
Default Value: 443.
Specify whether the server allows a self-signed certificate to access or not.
Must be either "false" or "true".
Default Value: false.
Specify the user name to login.
Must be a string.
Specify the password to login.
Must be an aes-cfb-128-encrypted string.
Specify the name of the datastore used for files and VMs.
Must be a string.
Specifes the cluster used for the placemnet of VM template.
Must be a string.
Use this command to deploy using the vCenter API.
Configures NICS.
Security Administrator, Administrator
Exec > Global Configuration
nics network_name Specify the vmware network name.
Must be a string.
Use this command to configure a list of networks assigned to VMs.
Displays system configuration information.
Security Administrator, Administrator
Exec
show { cli | confd-state | configuration | history | jobs | nacm | netconf-state | notification | parser | restconf-state | running-config | version } Use this command to view system configuration information.
Displays system configuration information.
Security Administrator, Administrator
Exec
version Use this command to view system configuration information.
Manages the available software packages.
Security Administrator, Administrator
Exec
software-packages { delete package_name | download { user user_name password password url url accept-self-signed-certificate { false | true } retain-package { false | true } | url url} | list } Use this command to download, delete, or list the available software packages.
Removes the specified software packages.
Security Administrator, Administrator
Exec
delete package package_name Specify the package name.
Must be a string.
Use this command to remove the specified software packages.
Downloads the software packages through HTTP/HTTPS protocols.
Security Administrator, Administrator
Exec
download { user user_name password password url url accept-self-signed-certificate { false | true } retain-package { false | true } | url url } Specify the URL.
Specify the user name for HTTP/HTTPS authentication.
Must be a string.
Specify the password for HTTP/HTTPS authentication.
Must be an aes-cfb-128-encrypted string.
Accept or deny self-signed-certificates for HTTPS URLs.
Must be either "false" or "true".
Default Value: false.
Use this command to download software packages.
Lists the available software packages.
Security Administrator, Administrator
Exec
list Use this command to lists the available software packages.
Feedback