CLI Command Reference
n2xctl account
Account administration for platform admins.
Usage
n2xctl account [command] [flags]
Available Commands:
show
Show account detailssubscription
Manage service subscriptionbilling
Manage invoices and billable items
Flags:
-h, --help
help for account--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl account subscription
Manage service subscription.
Usage
n2xctl account subscription [command] [flags]
Available Commands:
show
Show and update service subscriptioncancel
Cancel subscription and delete account
Flags:
-h, --help
help for subscription--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl account billing
Manage invoices and billable items.
Usage
n2xctl account billing [command] [flags]
Available Commands:
portal
Open the Billing Portal
Flags:
-h, --help
help for subscription--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl alert
Manage alert system.
Usage
n2xctl alert [command] [flags]
Available Commands:
list
List your alertsshow
Show alertdelete
Delete alert
Flags:
-h, --help
help for alert--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl auth
User session authentication commands.
Usage
n2xctl auth [command] [flags]
Available Commands:
login
Log inlogout
Log out
Flags:
-h, --help
help for auth--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl completion
Generate completion script.
Usage
n2xctl completion [command] [flags]
Available Commands:
bash
Generate the autocompletion script for bashzsh
Generate the autocompletion script for zshfish
Generate the autocompletion script for fishpowershell
Generate the autocompletion script for powershell
Flags:
-h, --help
help for completion--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl k8s
Connect kubernetes clusters to your n2x network.
Usage
n2xctl k8s [command] [flags]
Available Commands:
svc
Connect kubernetes services to your n2x networkworkload
Connect kubernetes workloads to your n2x networkdelete-gw
Remove n2x gateway from your kubernetes cluster
Flags:
-h, --help
help for k8s-n, --network string
network identifier-s, --subnet string
subnet identifier-t, --tenant string
tenant identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl k8s svc
Connect kubernetes services to your n2x network.
Usage
n2xctl k8s svc [command] [flags]
Available Commands:
list
List kubernetes services connected via n2x ingress gatewayconnect
Connect kubernetes services via n2x ingress gatewaydisconnect
Disconnect kubernetes services from n2x ingress gateway
Flags:
-h, --help
help for svc-n, --network string
network identifier-s, --subnet string
subnet identifier-t, --tenant string
tenant identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl k8s workload
Connect kubernetes workloads to your n2x network.
Usage
n2xctl k8s workload [command] [flags]
Available Commands:
list
List kubernetes workloads connected via n2x sidecarconnect
Add n2x sidecar to your kubernetes workloadsdisconnect
Remove n2x sidecar from your kubernetes workloads
Flags:
-h, --help
help for workload-n, --network string
network identifier-s, --subnet string
subnet identifier-t, --tenant string
tenant identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl network
Networks administration.
Usage
n2xctl network [command] [flags]
Available Commands:
list
List networksshow
Show networkcreate
Create a networkupdate
Update a networkdelete
Remove network
Flags:
-h, --help
help for network-n, --network string
network identifier-t, --tenant string
tenant identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl node
Network node operations for network administrators.
Usage
n2xctl node [command] [flags]
Available Commands:
add
Add a new nodelist
List nodesshow
Show nodeconnect
Connect (move) node to a subnetdisable-networking
Disable n2x networking and disconnect node from a subnetdelete
Remove node from databasemetrics
Show detailed metricsshow-endpoint
Show network endpoint detailsdelete-endpoint
Delete network endpoint
Flags:
-h, --help
help for node-n, --network string
network identifier-x, --node string
node identifier-s, --subnet string
subnet identifier-t, --tenant string
tenant identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl ops
Automation and workflows management commands.
Usage
n2xctl ops [command] [flags]
Available Commands:
project
Workflow projects administrationtasklog
Workflow tasklog administrationworkflow
Automation workflows administration
Flags:
-h, --help
help for ops--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl ops project
Workflow projects administration.
Usage
n2xctl ops project [command] [flags]
Available Commands:
list
List projectsshow
Show projectcreate
Create a projectupdate
Update a projectdelete
Remove project
Flags:
-h, --help
help for project-p, --project string
project identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl ops tasklog
Workflow tasklog administration.
Usage
n2xctl ops tasklog [command] [flags]
Available Commands:
list
List tasklogsshow
Show logdelete
Delete log
Flags:
-h, --help
help for tasklog-p, --project string
project identifier-t, --tasklog string
tasklog identifier-w, --workflow string
workflow identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl ops workflow
Automation workflows administration.
Usage
n2xctl ops workflow [command] [flags]
Available Commands:
list
List workflowsshow
Show workflowcreate
Create workflow from YAML fileupdate
Update workflow from YAML filedelete
Remove workflowenable
Enable workflowdisable
Disable workflow
Flags:
-h, --help
help for workflow-p, --project string
project identifier-w, --workflow string
workflow identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl policy
Security policies administration.
Usage
n2xctl policy [command] [flags]
Available Commands:
show
Show security policyset-default
Set default policyadd-rule
Add security policy ruleedit-rule
Edit security policy ruledelete-rule
Delete security policy ruledelete
Delete security policy (all rules)
Flags:
-h, --help
help for policy-n, --network string
network identifier-s, --subnet string
subnet identifier-t, --tenant string
tenant identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl subnet
Subnets administration.
Usage
n2xctl subnet [command] [flags]
Available Commands:
list
List subnetsshow
Show subnetcreate
Create a new subnetupdate
Update a subnetdelete
Remove subnetdelete-ipam-entry
Delete IPAM entry manually
Flags:
-h, --help
help for subnet-n, --network string
network identifier-s, --subnet string
subnet identifier-t, --tenant string
tenant identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl tenant
Tenants administration.
Usage
n2xctl tenant [command] [flags]
Available Commands:
list
List tenantsshow
Show tenantcreate
Create tenantupdate
Update tenant detailsdelete
Remove tenant
Flags:
-h, --help
help for tenant-t, --tenant string
tenant identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl version
Update client and show version information.
Usage
n2xctl version [command] [flags]
Available Commands:
show
Show n2xctl version informationupdate
Update n2xctl to the latest version
Flags:
-h, --help
help for version--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)
n2xctl vs
Virtual Servers (lb/ha services).
Usage
n2xctl vs [command] [flags]
Available Commands:
list
List virtual serversshow
Show virtual servercreate
Create virtual serverupdate
Update virtual serveradd-node-svc
Add node app service to VS high-availability groupremove-node-svc
Remove node app service from VS high-availability groupdelete
Remove virtual server
Flags:
-h, --help
help for vs-t, --tenant string
tenant identifier-v, --vs string
vs identifier--config string
configuration file (default: $HOME/.n2x/n2xctl.yml)