Cloudbreak CLI Reference
Also available as:
PDF

credential modify

Modifies an existing credential.

Note
Note

The --name parameter is used to identify the credential that is being modified, and therefore its value cannot be modified.

Sub-commands

aws role-based Modifies an AWS role-based credential

aws key-based Modifies an AWS key-based credential

aws-gov role-based Modifies an AWS role-based credential

aws-gov key-based Modifies an AWS key-based credential

azure app-based Modifies an app-based Azure credential

gcp p12-based Modifies a Google Cloud credential that uses a P12 key

gcp json-based Modifies a Google Cloud credential that uses a JSON key

openstack keystone-v2 Modifies an OpenStack v2 credential

openstack keystone-v3 Modifies an OpenStack v3 credential

Required options

Options required for aws role-based sub-command:

--name [$VALUE] Credential name

--role-arn [$VALUE] IAM Role ARN of the role used for the credential

Options required for aws key-based sub-command:

--name [$VALUE] Credential name

--access-key [$VALUE] AWS Access Key

--secret-key [$VALUE] AWS Secret Key

Options required for aws-gov role-based sub-command:

--name [$VALUE] Credential name

--role-arn [$VALUE] IAM Role ARN of the role used for the credential

Options required for aws-gov key-based sub-command:

--name [$VALUE] Credential name

--access-key [$VALUE] AWS Access Key

--secret-key [$VALUE] AWS Secret Key

Options required for azure app-based sub-command:

--name [$VALUE] Credential name

--subscription-id [$VALUE] Subscription ID from your Azure Subscriptions

--tenant-id [$VALUE] Directory ID from your Azure Active Directory > Properties

--app-id [$VALUE] Application ID of your app from your Azure Active Directory > App Registrations

--app-password [$VALUE] Your application key from app registration’s Settings > Keys

Options required for gcp p12-based sub-command:

--name [$VALUE] Credential name

--project-id [$VALUE] Project ID from your GCP account

--service-account-id [$VALUE] Your GCP Service account ID from IAM & Admin > Service accounts

--service-account-private-key-file [$VALUE] P12 key from your GCP service account

Options required for gcp json-based sub-command:

--name [$VALUE] Credential name

--service-account-json-file [$VALUE] JSON key from your GCP service account

Options required for openstack keystone-v2 sub-command:

--name [$VALUE] Credential name

--tenant-user [$VALUE] OpenStack user name

--tenant-password [$VALUE] OpenStack password

--tenant-name [$VALUE] OpenStack tenant name

--endpoint [$VALUE] OpenStack endpoint

Options required for openstack keystone-v3 sub-command:

--name [$VALUE] Credential name

--tenant-user [$VALUE] OpenStack user name

--tenant-password [$VALUE] OpenStack password

--user-domain [$VALUE] OpenStack user domain

--endpoint [$VALUE] OpenStack endpoint

Options

--description [$VALUE] Description of the resource

--server [$VALUE] Cloudbreak server address [$CB_SERVER_ADDRESS]

--username [$VALUE] Cloudbreak user name (e-mail address) [$CB_USER_NAME]

--password [$VALUE] Cloudbreak password [$CB_PASSWORD]

--workspace [$VALUE] Name of the workspace holding the resource

--profile [$VALUE] Selects a config profile to use [$CB_PROFILE]

--auth-type [$VALUE] Authentication method to use. Values: oauth2, basic [$CB_AUTH_TYPE]

Additionally, the following option is available for OpenStack Keystone2 and Keystone3:

--facing [$VALUE] API facing. One of: public, admin, internal

Additionally, the following options are available for OpenStack Keystone3:

--project-domain-name [$VALUE] OpenStack project domain name

--project-name [$VALUE] OpenStack project name

--domain-name [$VALUE] OpenStack domain name

--keystone-scope [$VALUE] OpenStack keystone scope. One of: default, domain, project

Examples

Modifies a role-based AWS credential:

cb credential modify aws role-based --name my-credential1 --role-arn arn:aws:iam::517127065441:role/CredentialRole

Modifies a key-based AWS credential:

cb credential modify aws key-based --name my-credential2 --access-key ABDVIRDFV3K4HLJ45SKA --secret-key D89L5pOPM+426Rtj3curKzJEJL3lYoNcP8GvguBV

Modifies a role-based AWSGov credential:

cb credential modify aws-gov role-based --name my-credential1 --role-arn arn:aws:iam::517127065441:role/CredentialRole

Modifies a key-based AWSGov credential:

cb credential modify aws-gov key-based --name my-credential2 --access-key ABDVIRDFV3K4HLJ45SKA --secret-key D89L5pOPM+426Rtj3curKzJEJL3lYoNcP8GvguBV

Modifies an app-based Azure credential:

cb credential modify azure app-based --name my-credential3 --subscription-id b8e7379e-568g-55d3-na82-45b8d421e998 --tenant-id  c79n5399-3231-65ba-8dgg-2g4e2a40085e --app-id 6d147d89-48d2-5de2-eef8-b89775bbfcg1 --app-password 4a8hBgfI52s/C8R5Sea2YHGnBFrD3fRONfdG8w7F2Ua=

Modifies a Google Cloud credential that uses a P12 key:

cb credential modify gcp --name my-credential4 --project-id test-proj --service-account-id test@test-proj.iam.gserviceaccount.com --service-account-private-key-file /Users/test/3fff57a6f68e.p12

Modifies a Google Cloud credential that uses a JSON key:

cb credential modify gcp --name my-credential5 --service-account-json-file /Users/test/3fff57a6f68e.json

Modifies a role-based OpenStack credential which uses Keystone-v2:

cb credential modify openstack keystone-v2 --name my-credential5 --tenant-user test --tenant-password MySecurePass123 --tenant-name test --endpoint http://openstack.test.organization.com:5000/v2.0