This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Auth

1 - pcloud auth

Authorization for pcloud

Synopsis

Commands to authorize pcloud.

Possibility to login, print-access-token, print-identity-token, revoke.

Before you can start using the pcloud tool, you must have an available Power Cloud instance that is provisioned and attached to a selected GCP project within your organization. This process occurs when you subscribe to the offering in the GCP Marketplace. Next, run the “pcloud auth login” command to authenticate to your cloud instance. When you authenticate, you must use the registered Google identity that is associated with the organization and the billing account that is used in the subscription. Running the “pcloud auth login” command provides ou with a unique code to register your pcloud instance.

pcloud auth [flags]

Options

  -h, --help   help for auth

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

2 - pcloud auth login

Login for pcloud

Synopsis

Login for pcloud.

Prompt for a user login.

When you provide either or both of the --account and --cloudInstance flags, pcloud will skip prompting you for those values and will instead verify that your authenticating user is authorized to those resources and if so, will set those values for the authenticated user.

When you provide --serviceAccountKey, the command will look to that file and attempt to use those credentials to authenticate. When the command does not find that file or it is not of the correct form, the command will warn you and then fallback to prompting you for authencitation.

Note: in cases where you are providing --serviceAccountKey the authentication will be short lived; meaning you will need to login again.

pcloud auth login [flags]

Options

  -a, --account string             Set the Account after authentication
  -c, --cloudInstance string       Set the Cloud Instance (via name or ID) after
                                   authentication
  -h, --help                       help for login
  -s, --serviceAccountKey string   Path to a service account key file to use for
                                   authentication

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

3 - pcloud auth print-access-token

Print access token

Synopsis

Print access token characteristics.

pcloud auth print-access-token [flags]

Options

  -b, --bare   print bare access token only
  -h, --help   help for print-access-token

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

4 - pcloud auth print-identity-token

Print identity token

Synopsis

Print identity token characteristics.

pcloud auth print-identity-token [flags]

Options

  -h, --help   help for print-identity-token

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

5 - pcloud auth revoke

Revoke credentials for pcloud

Synopsis

Revoke credentials for pcloud: effectively logout.

pcloud auth revoke [flags]

Options

  -h, --help   help for revoke

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

6 - pcloud auth sa

System Account Commands

Synopsis

System Account Commands

pcloud auth sa [flags]

Options

  -h, --help   help for sa

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

7 - pcloud auth sa create

add a system account user

Synopsis

add a system account user

pcloud auth sa create <sa-name> <sa-client-id> [--tenant=<tenant-id>] [--cloud=<cloud-id>] [flags]

Options

  -c, --cloud stringArray    Cloud ID
  -h, --help                 help for create
  -t, --tenant stringArray   Tenant ID

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

8 - pcloud auth sa delete

description

Synopsis

description

pcloud auth sa delete <sa-client-id> [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

9 - pcloud auth sa describe

description

Synopsis

description

pcloud auth sa describe <sa-client-id> [flags]

Options

  -h, --help   help for describe

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

10 - pcloud auth sa list

description

Synopsis

description

pcloud auth sa list usage [flags]

Options

  -h, --help   help for list

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

11 - pcloud auth sa load

create a service account from json keyfile

Synopsis

create a service account from json keyfile

pcloud auth sa load <key.json> [flags]

Options

  -h, --help   help for load

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

12 - pcloud auth sa update

update an existing sa account

Synopsis

update an existing sa account

pcloud auth sa update <sa-client-id> [-name=<name>] [-tenant=<tenant-id>] [-cloud=<cloud-id>] [flags]

Options

  -c, --cloud stringArray    Cloud ID
  -h, --help                 help for update
  -n, --name string          SA Account Name
  -t, --tenant stringArray   Tenant ID

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO