certificates
certificates add-tags
Usage
usage: symp certificates add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--system-tag]
certificates_id --tags [--tags ...]
Description
Add one or more tags to a certificate.
Mandatory
positional arguments:
certificates_id ID of the certificate
--tags List of tag strings to add in 'key=value', or JSON [{"key": "K", "value": "V"}, ...] format
Optional
optional arguments:
-h, --help show this help message and exit
--system-tag Whether to add a system tag (available only for admin)
certificates admin cluster-certificates auto-renew get
Usage
usage: symp certificates admin cluster-certificates auto-renew get
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
Get the Zadara certificate endpoint configuration to auto install and renew the zadara provided certificate.
Returns
Returns dict: The auto-renew configuration response
Optional
optional arguments:
-h, --help show this help message and exit
certificates admin cluster-certificates auto-renew set
Usage
usage: symp certificates admin cluster-certificates auto-renew set
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--cert-type CERT_TYPE] [--check]
url email token
Description
Configures a Zadara certificate endpoint to auto install and renew the zadara provided certificate. The certificate will only be installed & auto-renewed if there is no other custom certificate installed.
Mandatory
positional arguments:
url The URL of the certificates JSON endpoint (e.g. http://server/certificate/download.json)
email The email that will be used to authenticate to the certificate endpoint
token The api_token that will be used to authenticate to the certificate endpoint
Optional
optional arguments:
-h, --help show this help message and exit
--cert-type CERT_TYPE
The certificate key from the JSON endpoint that will be used. Defaults to "zadara"
--check Wether to immediately check the endpoint for a certificate and install it
certificates admin cluster-certificates auto-renew unset
Usage
usage: symp certificates admin cluster-certificates auto-renew unset
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
Unconfigures a Zadara certificate endpoint to disable auto install and renew the zadara provided certificate.
Optional
optional arguments:
-h, --help show this help message and exit
certificates admin cluster-certificates create
Usage
usage: symp certificates admin cluster-certificates create
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--passphrase PASSPHRASE]
[--auto-install]
certificate
private_key
Description
Creates a new cluster certificates object.
Mandatory
positional arguments:
certificate The PEM-encoded certificate to import
private_key The PEM-encoded, private key that matches the certificate's public key
Optional
optional arguments:
-h, --help show this help message and exit
--passphrase PASSPHRASE
A passphrase to be used for the private key, in case it's encrypted
--auto-install Whether to install the cluster certificate immediately after creation
certificates admin cluster-certificates delete
Usage
usage: symp certificates admin cluster-certificates delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
certificate_id
Description
Deletes a single cluster certificate object based on the supplied ID.
Mandatory
positional arguments:
certificate_id ID of the requested public certificate object
Optional
optional arguments:
-h, --help show this help message and exit
certificates admin cluster-certificates describe
Usage
usage: symp certificates admin cluster-certificates describe
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
certificate_id
Description
Describes a cluster certificate based on a certificates ID.
Mandatory
positional arguments:
certificate_id ID of the requested cluster certificate object
Optional
optional arguments:
-h, --help show this help message and exit
certificates admin cluster-certificates get
Usage
usage: symp certificates admin cluster-certificates get
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
certificate_id
Description
Returns the cluster certificate based on a cluster certificate ID.
Returns
Returns dict: Certificates response
Mandatory
positional arguments:
certificate_id ID of the requested public certificate object
Optional
optional arguments:
-h, --help show this help message and exit
certificates admin cluster-certificates get-current
Usage
usage: symp certificates admin cluster-certificates get-current
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
Returns the currently installed cluster certificate.
Returns
Returns dict: Certificates response
Optional
optional arguments:
-h, --help show this help message and exit
certificates admin cluster-certificates install
Usage
usage: symp certificates admin cluster-certificates install
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--force]
certificate_id
Description
Installs a cluster certificate based on the specified certificates ID.
Mandatory
positional arguments:
certificate_id ID of the requested cluster certificate object
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore validation errors
certificates admin cluster-certificates list
Usage
usage: symp certificates admin cluster-certificates list
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
Returns all the cluster certificates.
Returns
Returns list: Certificates response
Optional
optional arguments:
-h, --help show this help message and exit
certificates admin cluster-certificates uninstall
Usage
usage: symp certificates admin cluster-certificates uninstall
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--force]
certificate_id
Description
Uninstalls a cluster certificate based on the specified certificates ID. A self-signed certificate will be installed in place of the current certificate.
Mandatory
positional arguments:
certificate_id ID of the requested cluster certificate object
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore validation errors
certificates authorities add-tags
Usage
usage: symp certificates authorities add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--system-tag]
ca_id --tags [--tags ...]
Description
Adds one or more tags to your private CA.
Mandatory
positional arguments:
ca_id ID of the CA to add tags to
--tags List of tag strings to add in 'key=value', or JSON [{"key": "K", "value": "V"}, ...] format
Optional
optional arguments:
-h, --help show this help message and exit
--system-tag Whether to add a system tag (available only for admin)
certificates authorities create
Usage
usage: symp certificates authorities create
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--name NAME]
[--tags [TAGS [TAGS ...]]]
subject_common_name
Description
Creates a new self-signed root CA object. Returns CA certificate and private key.
Returns
Returns dict: CA response
Mandatory
positional arguments:
subject_common_name CN to set as the Subject and the Issuer
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Display name for the CA
--tags [TAGS [TAGS ...]]
List of tags to add to the CA
certificates authorities delete
Usage
usage: symp certificates authorities delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--override-protection]
ca_id
Description
Deletes a single CA certificate object based on the supplied ID .
Mandatory
positional arguments:
ca_id ID of the requested CA certificate object
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
Delete managed resources, normally protected from deletion (admin only)
certificates authorities describe
Usage
usage: symp certificates authorities describe
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
ca_id
Description
Describes a CA certificate based on a CA ID.
Returns
Returns dict: Certificates response
Mandatory
positional arguments:
ca_id ID of the requested CA certificate object
Optional
optional arguments:
-h, --help show this help message and exit
certificates authorities get
Usage
usage: symp certificates authorities get
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
ca_id
Description
Returns a CA certificate based on a CA ID.
Returns
Returns dict: CA response
Mandatory
positional arguments:
ca_id ID of the requested CA object
Optional
optional arguments:
-h, --help show this help message and exit
certificates authorities issue-certificate
Usage
usage: symp certificates authorities issue-certificate
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--name NAME]
ca_id csr_pem
Description
Issues a certificate based on a CSR, signed by the CA. Returns a certificate ID.
Returns
Returns uuid: Certificate ID
Mandatory
positional arguments:
ca_id ID of the requested CA certificate object
csr_pem CSR in PEM format
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Display name for the certificate
certificates authorities list
Usage
usage: symp certificates authorities list
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
Returns all CA certificates.
Returns
Returns list: CA Certificate objects
Optional
optional arguments:
-h, --help show this help message and exit
certificates authorities list-tags
Usage
usage: symp certificates authorities list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
ca_id
Description
Lists the tags, if any, that are associated with your private CA.
Returns
Returns list: Tag objects
Mandatory
positional arguments:
ca_id ID of the CA to list tags for
Optional
optional arguments:
-h, --help show this help message and exit
certificates authorities remove-tags
Usage
usage: symp certificates authorities remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--force] [--system-tag]
ca_id --tags [--tags ...]
Description
Remove one or more tags from your private CA.
Mandatory
positional arguments:
ca_id ID of the CA to remove tags from
--tags List of tag strings to add in 'key=value', or JSON [{"key": "K", "value": "V"}, ...] format
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)
certificates create
Usage
usage: symp certificates create
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--certificate-chain CERTIFICATE_CHAIN]
[--chain CHAIN] [--name NAME]
[--tags [TAGS [TAGS ...]]] [--skip-validation]
certificate private_key
Description
Creates a new certificates object.
Returns
Returns dict: Certificates response
Mandatory
positional arguments:
certificate The PEM-encoded certificate to import
private_key The PEM-encoded, unencrypted private key that matches the certificate's public key
Optional
optional arguments:
-h, --help show this help message and exit
--certificate-chain CERTIFICATE_CHAIN
The entire PEM-encoded certificate chain except for your certificate
--chain CHAIN (deprecated)
--name NAME Name for the certificate
--tags [TAGS [TAGS ...]]
List of tags to add to the certificate
--skip-validation Skip chain/private_key/public key validation
certificates delete
Usage
usage: symp certificates delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--override-protection]
certificates_id
Description
Deletes a single certificates object based on the ID supplied.
Mandatory
positional arguments:
certificates_id ID of the requested certificates object
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
Delete managed resources, normally protected from deletion (admin only)
certificates describe
Usage
usage: symp certificates describe
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
certificates_id
Description
Describes a certificates based on a certificates ID.
Returns
Returns dict: Certificates response
Mandatory
positional arguments:
certificates_id ID of the requested certificates object
Optional
optional arguments:
-h, --help show this help message and exit
certificates get
Usage
usage: symp certificates get
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
certificates_id
Description
Returns a certificates based on a certificates ID.
Returns
Returns dict: Certificates response
Mandatory
positional arguments:
certificates_id ID of the requested certificates object
Optional
optional arguments:
-h, --help show this help message and exit
certificates list
Usage
usage: symp certificates list
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
Returns all certificates objects.
Returns
Returns list: Certificates objects
Optional
optional arguments:
-h, --help show this help message and exit
certificates list-tags
Usage
usage: symp certificates list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
certificates_id
Description
Lists the tags that have been applied to the certificate.
Returns
Returns list: Tag objects
Mandatory
positional arguments:
certificates_id IDs of the certificate to list tags for
Optional
optional arguments:
-h, --help show this help message and exit
certificates public-certificates create
Usage
usage: symp certificates public-certificates create
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--name NAME]
certificate
Description
Creates a new certificates object.
Mandatory
positional arguments:
certificate The PEM-encoded certificate to import
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name for the certificate
certificates public-certificates delete
Usage
usage: symp certificates public-certificates delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
certificates_id
Description
Deletes a single public certificate object based on the supplied ID .
Mandatory
positional arguments:
certificates_id ID of the requested public certificate object
Optional
optional arguments:
-h, --help show this help message and exit
certificates public-certificates describe
Usage
usage: symp certificates public-certificates describe
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
certificates_id
Description
Describes a public certificate based on a certificates ID.
Returns
Returns dict: Certificates response
Mandatory
positional arguments:
certificates_id ID of the requested public certificate object
Optional
optional arguments:
-h, --help show this help message and exit
certificates public-certificates get
Usage
usage: symp certificates public-certificates get
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
certificates_id
Description
Returns a public certificate based on a public certificate ID.
Returns
Returns dict: Certificates response
Mandatory
positional arguments:
certificates_id ID of the requested public certificate object
Optional
optional arguments:
-h, --help show this help message and exit
certificates public-certificates list
Usage
usage: symp certificates public-certificates list
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
Returns all public certificates objects.
Returns
Returns list: Public Certificate objects
Optional
optional arguments:
-h, --help show this help message and exit
certificates remove-tags
Usage
usage: symp certificates remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--force] [--system-tag]
certificates_id --tags [--tags ...]
Description
Remove one or more tags from a certificate.
Mandatory
positional arguments:
certificates_id ID of the certificates to remove tags from
--tags List of tag strings to add in 'key=value', or JSON [{"key": "K", "value": "V"}, ...] format
Optional
optional arguments:
-h, --help show this help message and exit
--force Whether to ignore non-existing resources
--system-tag Whether to remove a system tag (available only for admin)