profile

The profile command manages multiple credentials used to authenticate and interact with NexusOne.

`add`

The add subcommand add a credential to a profile configuration file. It also updates the credential.

nx1 profile add \
  --name <profile_name> \
  --api-key <api_key> \
  --host <api_host>

Options

string

required

Name of the profile.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`list`

The list subcommand lists credentials in a profile configuration file.

nx1 profile list --name <profile_name>

Options

string

required

Name of the profile.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`path`

The path subcommand shows the path to a profile configuration file.

nx1 profile path --name <profile_name>

Options

string

required

Name of the profile.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`remove`

The remove subcommand removes a credential from a profile configuration file.

nx1 profile remove <name>

Argument

string

required

Unique name of the previously created profile.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

`show`

The show subcommand shows a credential in a profile configuration file.

nx1 profile show <name>

Argument

string

required

Unique name of the previously created profile.

Global options

string

API key or the NX1_API_KEY variable.

string

YAML config file.

Shows help messages and exit.

string

API host.

Disables SSL verification.

string

Output format. Allowed values: json, yaml, or table.

string

Profile name from ~/.nx1/profiles.

integer

Requests when to timeout. Default is 30.

Verbose output.

Using the CLIs

CLI tools

`add`

`list`

`path`

`remove`

`show`

Using the CLIs

CLI tools

​add

​list

​path

​remove

​show

`add`

`list`

`path`

`remove`

`show`