profile¶

Manage Code42 connection settings.

profile [OPTIONS] COMMAND [ARGS]...

create¶

Create profile settings. The first profile created will be the default.

profile create [OPTIONS]

Options

-n, --name <name>¶: Required The name of the Code42 CLI profile to use when executing this command.

-s, --server <server>¶: Required The URL you use to sign into Code42.

-u, --username <username>¶: Required The username of the Code42 API user.

--password <password>¶: The password for the Code42 API user. If this option is omitted, interactive prompts will be used to obtain the password.

--totp <totp>¶: TOTP token for multi-factor authentication.

--disable-ssl-errors¶: For development purposes, do not validate the SSL certificates of Code42 servers. This is not recommended, except for specific scenarios like testing.

-d, --debug¶: Turn on debug logging.

delete¶

Deletes a profile and its stored password (if any).

profile delete [OPTIONS] PROFILE_NAME

Options

-y, --assume-yes¶: Assume “yes” as the answer to all prompts and run non-interactively.

Arguments

PROFILE_NAME¶: Required argument

delete-all¶

Deletes all profiles and saved passwords (if any).

profile delete-all [OPTIONS]

Options

-y, --assume-yes¶: Assume “yes” as the answer to all prompts and run non-interactively.

list¶

Show all existing stored profiles.

profile list [OPTIONS]

reset-pw¶

Change the stored password for a profile. Only affects what’s stored in the local profile,

does not make any changes to the Code42 user account.

profile reset-pw [OPTIONS] [PROFILE_NAME]

Options

-d, --debug¶: Turn on debug logging.

Arguments

PROFILE_NAME¶: Optional argument

show¶

Print the details of a profile.

profile show [OPTIONS] [PROFILE_NAME]

Arguments

PROFILE_NAME¶: Optional argument

update¶

Update an existing profile.

profile update [OPTIONS]

Options

-n, --name <name>¶: The name of the Code42 CLI profile to use when executing this command.

-s, --server <server>¶: The URL you use to sign into Code42.

-u, --username <username>¶: The username of the Code42 API user.

--password <password>¶: The password for the Code42 API user. If this option is omitted, interactive prompts will be used to obtain the password.

--totp <totp>¶: TOTP token for multi-factor authentication.

--disable-ssl-errors¶: For development purposes, do not validate the SSL certificates of Code42 servers. This is not recommended, except for specific scenarios like testing.

-d, --debug¶: Turn on debug logging.

use¶

Set a profile as the default. If not providing a profile-name,

prompts for a choice from a list of all profiles.

profile use [OPTIONS] [PROFILE_NAME]

Arguments

PROFILE_NAME¶: Optional argument