CLI Command Reference

n2xctl account

Account administration for platform admins.

Available Commands:

• show Show account details
• subscription Manage service subscription
• billing 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.

Available Commands:

• show Show and update service subscription
• cancel 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.

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.

Available Commands:

• list List your alerts
• show Show alert
• delete Delete alert

Flags:

• -h, --help help for alert
• --config string configuration file (default: $HOME/.n2x/n2xctl.yml)

n2xctl auth

User session authentication commands.

Available Commands:

• login Log in
• logout Log out

Flags:

• -h, --help help for auth
• --config string configuration file (default: $HOME/.n2x/n2xctl.yml)

n2xctl completion

Generate completion script.

Available Commands:

• bash Generate the autocompletion script for bash
• zsh Generate the autocompletion script for zsh
• fish Generate the autocompletion script for fish
• powershell 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.

Available Commands:

• svc Connect kubernetes services to your n2x network
• workload Connect kubernetes workloads to your n2x network
• delete-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.

Available Commands:

• list List kubernetes services connected via n2x ingress gateway
• connect Connect kubernetes services via n2x ingress gateway
• disconnect 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.

Available Commands:

• list List kubernetes workloads connected via n2x sidecar
• connect Add n2x sidecar to your kubernetes workloads
• disconnect 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.

Available Commands:

• list List networks
• show Show network
• create Create a network
• update Update a network
• delete 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.

Available Commands:

• add Add a new node
• list List nodes
• show Show node
• connect Connect (move) node to a subnet
• disable-networking Disable n2x networking and disconnect node from a subnet
• delete Remove node from database
• metrics Show detailed metrics
• show-endpoint Show network endpoint details
• delete-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.

Available Commands:

• project Workflow projects administration
• tasklog Workflow tasklog administration
• workflow Automation workflows administration

Flags:

• -h, --help help for ops
• --config string configuration file (default: $HOME/.n2x/n2xctl.yml)

n2xctl ops project

Workflow projects administration.

Available Commands:

• list List projects
• show Show project
• create Create a project
• update Update a project
• delete 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.

Available Commands:

• list List tasklogs
• show Show log
• delete 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.

Available Commands:

• list List workflows
• show Show workflow
• create Create workflow from YAML file
• update Update workflow from YAML file
• delete Remove workflow
• enable Enable workflow
• disable 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.

Available Commands:

• show Show security policy
• set-default Set default policy
• add-rule Add security policy rule
• edit-rule Edit security policy rule
• delete-rule Delete security policy rule
• delete 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.

Available Commands:

• list List subnets
• show Show subnet
• create Create a new subnet
• update Update a subnet
• delete Remove subnet
• delete-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.

Available Commands:

• list List tenants
• show Show tenant
• create Create tenant
• update Update tenant details
• delete 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.

Available Commands:

• show Show n2xctl version information
• update 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).

Available Commands:

• list List virtual servers
• show Show virtual server
• create Create virtual server
• update Update virtual server
• add-node-svc Add node app service to VS high-availability group
• remove-node-svc Remove node app service from VS high-availability group
• delete 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)