variable

Variable management commands for NDCLI. Variables are key-value pairs that can be defined at different scopes and referenced in snippets and templates using a {{ variable_name }} syntax.

Command alias: var

Scopes

Variables are resolved from the most specific scope to the most general:

Scope	Description
device	Applies to a single device
ou	Applies to all devices in an Organizational Unit
template	Applies to all devices using a template
org	Applies to all devices in the organization

When the same variable name is defined at multiple scopes, the most specific scope wins.

Commands

Command	Description
variable overview	Show all variables across scopes
variable org list	List organization-level variables
variable org describe	Show an organization-level variable
variable org create	Create an organization-level variable
variable org set	Update an organization-level variable
variable org delete	Delete an organization-level variable
variable ou list	List OU-level variables
variable ou describe	Show an OU-level variable
variable ou create	Create an OU-level variable
variable ou set	Update an OU-level variable
variable ou delete	Delete an OU-level variable
variable template list	List template-level variables
variable template describe	Show a template-level variable
variable template create	Create a template-level variable
variable template set	Update a template-level variable
variable template delete	Delete a template-level variable
variable device list	List device-level variables
variable device describe	Show a device-level variable
variable device create	Create a device-level variable
variable device set	Update a device-level variable
variable device delete	Delete a device-level variable

---

variable overview

Show all variables with their definitions across all scopes. Useful for understanding which variables are defined and where they come from.

ndcli variable overview [flags]

Flags

Flag	Type	Default	Description
--name	string		Filter by name pattern (regex)
--page	int	1	Page number
--per-page	int	50	Items per page

Examples

ndcli variable overview

ndcli variable overview --name "dns.*"

ndcli var overview -f json

---

variable org list

List all variables defined at the organization level.

ndcli variable org list [flags]

Flags

Flag	Type	Default	Description
--name	string		Filter by name pattern (regex)
--page	int	1	Page number
--per-page	int	50	Items per page

Examples

ndcli variable org list

ndcli variable org list --name "ntp.*"

---

variable org describe

Show details of a specific organization-level variable.

ndcli variable org describe [variable]

Arguments

Argument	Required	Description
variable	Yes	Variable name

Examples

ndcli variable org describe ntp_server

---

variable org create

Create a new organization-level variable.

ndcli variable org create [name] [value] [flags]

Arguments

Argument	Required	Description
name	Yes	Variable name
value	Yes	Variable value

Flags

Flag	Type	Default	Description
--description	string		Human-readable description
--secret	bool	false	Mark as secret — value is redacted in API responses

Examples

ndcli variable org create ntp_server 192.168.1.1

ndcli variable org create ntp_server 192.168.1.1 --description "Primary NTP server"

ndcli variable org create api_key "my-secret" --secret

---

variable org set

Update an existing organization-level variable.

ndcli variable org set [variable] [flags]

Arguments

Argument	Required	Description
variable	Yes	Variable name

Flags

Flag	Type	Default	Description
--value	string		New value
--description	string		New description

Examples

ndcli variable org set ntp_server --value 10.0.0.1

ndcli variable org set ntp_server --description "Updated NTP server"

---

variable org delete

Delete an organization-level variable.

ndcli variable org delete [variable] [flags]

Arguments

Argument	Required	Description
variable	Yes	Variable name

Flags

Flag	Type	Default	Description
-y, --yes	bool	false	Skip confirmation prompt

Examples

ndcli variable org delete old_variable

---

variable ou list

List all variables defined for an Organizational Unit.

ndcli variable ou list [OU] [flags]

Arguments

Argument	Required	Description
OU	Yes	Organizational Unit name

Flags

Flag	Type	Default	Description
--name	string		Filter by name pattern (regex)
--page	int	1	Page number
--per-page	int	50	Items per page

Examples

ndcli variable ou list production

---

variable ou describe

Show details of a specific OU-level variable.

ndcli variable ou describe [OU] [variable]

Arguments

Argument	Required	Description
OU	Yes	Organizational Unit name
variable	Yes	Variable name

Examples

ndcli variable ou describe production dns_server

---

variable ou create

Create a variable at the OU level.

ndcli variable ou create [OU] [name] [value] [flags]

Arguments

Argument	Required	Description
OU	Yes	Organizational Unit name
name	Yes	Variable name
value	Yes	Variable value

Flags

Flag	Type	Default	Description
--description	string		Human-readable description

Examples

ndcli variable ou create production dns_server 10.10.0.53

ndcli variable ou create staging dns_server 10.20.0.53 --description "Staging DNS"

---

variable ou set

Update an OU-level variable.

ndcli variable ou set [OU] [variable] [flags]

Arguments

Argument	Required	Description
OU	Yes	Organizational Unit name
variable	Yes	Variable name

Flags

Flag	Type	Default	Description
--value	string		New value
--description	string		New description

Examples

ndcli variable ou set production dns_server --value 10.10.1.53

---

variable ou delete

Delete an OU-level variable.

ndcli variable ou delete [OU] [variable] [flags]

Arguments

Argument	Required	Description
OU	Yes	Organizational Unit name
variable	Yes	Variable name

Flags

Flag	Type	Default	Description
-y, --yes	bool	false	Skip confirmation prompt

Examples

ndcli variable ou delete production old_var

---

variable template list

List all variables defined for a template.

ndcli variable template list [template] [flags]

Arguments

Argument	Required	Description
template	Yes	Template name

Flags

Flag	Type	Default	Description
--name	string		Filter by name pattern (regex)
--page	int	1	Page number
--per-page	int	50	Items per page

Examples

ndcli variable template list base-config

---

variable template describe

Show details of a specific template-level variable.

ndcli variable template describe [template] [variable]

Arguments

Argument	Required	Description
template	Yes	Template name
variable	Yes	Variable name

Examples

ndcli variable template describe base-config timezone

---

variable template create

Create a variable at the template level.

ndcli variable template create [template] [name] [value] [flags]

Arguments

Argument	Required	Description
template	Yes	Template name
name	Yes	Variable name
value	Yes	Variable value

Flags

Flag	Type	Default	Description
--description	string		Human-readable description

Examples

ndcli variable template create base-config timezone UTC

ndcli variable template create base-config timezone "America/New_York" --description "Default timezone"

---

variable template set

Update a template-level variable.

ndcli variable template set [template] [variable] [flags]

Arguments

Argument	Required	Description
template	Yes	Template name
variable	Yes	Variable name

Flags

Flag	Type	Default	Description
--value	string		New value
--description	string		New description

Examples

ndcli variable template set base-config timezone --value "Europe/London"

---

variable template delete

Delete a template-level variable.

ndcli variable template delete [template] [variable] [flags]

Arguments

Argument	Required	Description
template	Yes	Template name
variable	Yes	Variable name

Flags

Flag	Type	Default	Description
-y, --yes	bool	false	Skip confirmation prompt

Examples

ndcli variable template delete base-config old_var

---

variable device list

List all variables defined for a specific device.

ndcli variable device list [device] [flags]

Arguments

Argument	Required	Description
device	Yes	Device name

Flags

Flag	Type	Default	Description
--name	string		Filter by name pattern (regex)
--page	int	1	Page number
--per-page	int	50	Items per page

Examples

ndcli variable device list my-firewall

---

variable device describe

Show details of a specific device-level variable.

ndcli variable device describe [device] [variable]

Arguments

Argument	Required	Description
device	Yes	Device name
variable	Yes	Variable name

Examples

ndcli variable device describe my-firewall wan_ip

---

variable device create

Create a variable at the device level.

ndcli variable device create [device] [name] [value] [flags]

Arguments

Argument	Required	Description
device	Yes	Device name
name	Yes	Variable name
value	Yes	Variable value

Flags

Flag	Type	Default	Description
--description	string		Human-readable description

Examples

ndcli variable device create my-firewall wan_ip 203.0.113.1

ndcli variable device create my-firewall wan_ip 203.0.113.1 --description "WAN IP address"

---

variable device set

Update a device-level variable.

ndcli variable device set [device] [variable] [flags]

Arguments

Argument	Required	Description
device	Yes	Device name
variable	Yes	Variable name

Flags

Flag	Type	Default	Description
--value	string		New value
--description	string		New description

Examples

ndcli variable device set my-firewall wan_ip --value 203.0.113.2

---

variable device delete

Delete a device-level variable.

ndcli variable device delete [device] [variable] [flags]

Arguments

Argument	Required	Description
device	Yes	Device name
variable	Yes	Variable name

Flags

Flag	Type	Default	Description
-y, --yes	bool	false	Skip confirmation prompt

Examples

ndcli variable device delete my-firewall old_var