external-endpoint¶
external-endpoint create¶
Usage
usage: symp external-endpoint create
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--description DESCRIPTION]
[--permission PERMISSION]
endpoint_type name details
Description
Create an external endpoint
Returns
Returns dict: External endpoint
Mandatory
positional arguments:
endpoint_type Endpoint type ['s3', 'nfs', 'rsyslog', 'logstash', 'influxdb', 'vmware', 'active_directory', 'zendesk', 'smtp', 'vpsa_backup', 'kms']
name Name for the external endpoint
details Properties of external endpoint
s3 - '{"s3_region":"","s3_endpoint_url":"","s3_bucket":"","s3_access_key":"","s3_secret_key":"","s3_verify_ssl":true}'
nfs - '{"nfs_share":"","nfs_mount_options":""}'
rsyslog - '{"rsyslog_hostname":"rsyslog_hostname/IP","rsyslog_port":514,"rsyslog_protocol":"udp"}'
logstash - '{"logstash_hostname":"","logstash_port":10000,"logstash_protocol":"tcp"}'
influxdb - '{"influxdb_hostname":"","influxdb_port":8086,"influxdb_database":"metrics", "influxdb_username":"","influxdb_password":""}'
vmware - '{"vmware_hostname":"","vmware_port":443, "vmware_username":"","vmware_password":"","vmware_resource_pool":"", "vmware_datacenter":""}'
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_share":"","vpsa_nfs_mount_options":"", "vpsa_remote_name":"", "vpsa_remote_pool_name":"", "vpsa_snapshot_policy_name":""}'
kms - '{"kms_ip":["kms ip array"]}'
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: symp external-endpoint delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
external_endpoint_id
Description
Delete the external endpoint
Mandatory
positional arguments:
external_endpoint_id The ID of the external endpoint
Optional
optional arguments:
-h, --help show this help message and exit
external-endpoint get¶
Usage
usage: symp external-endpoint get
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--show-deleted SHOW_DELETED]
external_endpoint_id
Description
Retrieve an external endpoint
Returns
Returns dict: External endpoint
Mandatory
positional arguments:
external_endpoint_id The ID of the 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: symp external-endpoint 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 ...]]]
[--show-deleted SHOW_DELETED]
[--endpoint-type-eq ENDPOINT_TYPE_EQ]
Description
Retrieves all external endpoints
Returns
Returns list: List of external endpoints
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', 'kms']
external-endpoint undelete¶
Usage
usage: symp external-endpoint undelete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
external_endpoint_id
Description
Undelete an external endpoint
Returns
Returns dict: External endpoint
Mandatory
positional arguments:
external_endpoint_id The ID of the external endpoint
Optional
optional arguments:
-h, --help show this help message and exit
external-endpoint update¶
Usage
usage: symp external-endpoint update
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--description DESCRIPTION]
[--details DETAILS] [--name NAME]
[--permission PERMISSION]
external_endpoint_id
Description
Update external endpoint properties
Returns
Returns dict: Updated external endpoint
Mandatory
positional arguments:
external_endpoint_id The ID of the 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":""}'
kms - '{"kms_ip":["kms ip array"]}'
--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: symp external-endpoint validate
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
external_endpoint_id
Description
Validate an external endpoint
Returns
Returns dict: External endpoint validate result
Mandatory
positional arguments:
external_endpoint_id The ID of the external endpoint
Optional
optional arguments:
-h, --help show this help message and exit