external-endpoint

external-endpoint create

Usage

usage: -c external-endpoint create [-h]
                                [-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [--description DESCRIPTION]
                                [--permission PERMISSION]
                                endpoint_type name details

Description

Create an external endpoint

Return

Returns dict: External endpoint

Optional

 optional arguments:
-h, --help            show this help message and exit
--description DESCRIPTION
                      Description for the external endpoint
--permission PERMISSION
                      '{"scope_type": "project","scope_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6","access_mode": "read-write"}'

external-endpoint delete

Usage

usage: -c external-endpoint delete [-h]
                                [-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                external_endpoint_id

Description

Delete the external endpoint

Return

None

Optional

 optional arguments:
-h, --help            show this help message and exit

external-endpoint get

Usage

usage: -c external-endpoint get [-h]
                             [-f {adaptive_table,json,shell,table,value,yaml}]
                             [-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
                             [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             [--show-deleted SHOW_DELETED]
                             external_endpoint_id

Description

Retrieve an external endpoint

Return

Returns dict: External endpoint

Optional

 optional arguments:
-h, --help            show this help message and exit
--show-deleted SHOW_DELETED
                      whether or not the query should return a deleted endpoint

external-endpoint list

Usage

usage: -c external-endpoint list [-h]
                              [-f {adaptive_table,csv,json,table,value,yaml}]
                              [-c COLUMN]
                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                              [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--show-deleted SHOW_DELETED]
                              [--endpoint-type-eq ENDPOINT_TYPE_EQ]

Description

Retrieves all external endpoints

Return

None

Optional

 optional arguments:
-h, --help            show this help message and exit
--show-deleted SHOW_DELETED
                      whether or not the query should return deleted endpoints
--endpoint-type-eq ENDPOINT_TYPE_EQ
                      Return snapshots with the specified endpoint type.
                      Endpoint types: ['s3', 'nfs', 'rsyslog', 'logstash', 'influxdb', 'vmware', 'active_directory', 'zendesk', 'smtp', 'vpsa_backup']

external-endpoint undelete

Usage

usage: -c external-endpoint undelete [-h]
                                  [-f {adaptive_table,json,shell,table,value,yaml}]
                                  [-c COLUMN]
                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                  [--max-width <integer>] [--noindent]
                                  [--prefix PREFIX]
                                  external_endpoint_id

Description

Undelete an external endpoint

Return

Returns dict: External endpoint

Optional

 optional arguments:
-h, --help            show this help message and exit

external-endpoint update

Usage

usage: -c external-endpoint update [-h]
                                [-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [--description DESCRIPTION]
                                [--details DETAILS] [--name NAME]
                                [--permission PERMISSION]
                                external_endpoint_id

Description

Update external endpoint properties

Return

Returns dict: Updated external endpoint

Optional

 optional arguments:
-h, --help            show this help message and exit
--description DESCRIPTION
                      Description for the external endpoint
--details DETAILS     Properties of external endpoint
                      s3  - '{"s3_access_key":"","s3_secret_key":"","s3_verify_ssl":true}'
                      nfs - '{"nfs_mount_options":""}'
                      logstash - '{"logstash_hostname":"","logstash_port":10000,"logstash_protocol":"tcp"}'
                      vmware  - '{"vmware_username":"","vmware_password":""}
                      - Both are required'
                      active_directory  - '{"ad_domain_name":"","ad_domain_user":"", "ad_domain_password":""}'
                      zendesk - '{"zendesk_address":"","zendesk_username":"","zendesk_password":""}'
                      smtp - '{"smtp_host":"","smtp_port":25,"smtp_from":"","smtp_to":"","smtp_username":"","smtp_password":"","smtp_ssl":true}'
                      vpsa_backup - '{"vpsa_nfs_mount_options":""}'
--name NAME           Name for the external endpoint
--permission PERMISSION
                      '{"scope_type": "project","scope_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6","access_mode": "read-write"}'
                      scope_type and access_mode are required

external-endpoint validate

Usage

usage: -c external-endpoint validate [-h]
                                  [-f {adaptive_table,json,shell,table,value,yaml}]
                                  [-c COLUMN]
                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                  [--max-width <integer>] [--noindent]
                                  [--prefix PREFIX]
                                  external_endpoint_id

Description

Validate an external endpoint

Return

Returns dict: External endpoint validate result

Optional

 optional arguments:
-h, --help            show this help message and exit