Справочник CLI
Введение
Справочник CLI содержит список команд, которые можно использовать в командной строке для управления ПО Sharx Base. В справочнике указан синтаксис команд, доступные опции и аргументы, а также краткое описание их функций.
Требования
Необходимо установить интерфейс командной строки sdc-cli.
Подробная информация приведена в статье Требования к интерфейсу командной строки.
Список команд
Примечание
Справочник доступен только на английском языке
cluster
Create new Cluster
cluster add
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--node_ids [NODE_IDS [NODE_IDS ...]]— list of node IDs;--vip VIP— VIP IP-address of cluster.
Delete Cluster
cluster del
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name.
Delete free node
cluster freenodes del
Optional arguments:
-h,--help— show help message and exit.
Get free nodes list
cluster freenodes list
Optional arguments:
-h,--help— show help message and exit.
Get clusters list
cluster list
Optional arguments:
-h,--help— show help message and exit.
Get metrics
cluster metrics list
Optional arguments:
-h,--help— show help message and exit.
Add Cluster node
cluster nodes add
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--node NODE— node ID.
Delete Cluster node
cluster nodes del
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--node NODE— node ID.
Get clusters node list
cluster nodes list
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;
Modify Cluster node
cluster nodes update
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--node NODE— node ID;--op {start,stop}— начальное состояние узла.
Add plugin to cluster
cluster plugins add
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--plugin PLUGIN— plugin name.
Delete plugin from cluster
cluster plugins del
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--plugin PLUGIN— plugin name.
Get clusters plugin list
cluster plugins listapispec_1
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name.
Get plugin descripsion
cluster plugins show
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--plugin PLUGIN— plugin name.
Get plugin list
cluster repo list
Optional arguments:
-h,--help— show help message and exit.
Plugin install
cluster repo plugins add
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--plugin PLUGIN— plugin name.
Plugin uninstall
cluster repo plugins del
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--plugin PLUGIN— plugin name.
Get clusters plugin list
cluster repo plugins list
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name.
Get cluster version
cluster version list
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name.
Change VIP IP-address of cluster
cluster vip add
Optional arguments:
-h,--help— show help message and exit;--cluster CLUSTER— cluster name;--vip VIP— VIP IP-address of cluster.
aaa plugin
View available RAM and CPU resources by nodes
aaa cluster nodes resource show
Add HA resources to cluster
aaa cluster resource ha add
> aaa cluster resource ha add [-h] [--reserved_ha_cpu RESERVED_HA_CPU]
[--reserved_ha_ram RESERVED_HA_RAM]
[--reserved_ha_disk RESERVED_HA_DISK]
[--resources_share RESOURCES_SHARE]
arguments:
-h, --help show this help message and exit
--reserved_ha_cpu RESERVED_HA_CPU - Reserved HA CPU percent
--reserved_ha_ram RESERVED_HA_RAM - Reserved HA RAM percent
--reserved_ha_disk RESERVED_HA_DISK - Reserved HA Disk percent
--resources_share RESOURCES_SHARE - Cluster resource sharing (Default - no) ['yes', 'no']
Delete HA resources from cluster
aaa cluster resource ha del
Show HA resources from cluster
aaa cluster resource ha show
Update HA resources to cluster
aaa cluster resource ha update
> aaa cluster resource ha update [-h] [--reserved_ha_cpu RESERVED_HA_CPU]
[--reserved_ha_ram RESERVED_HA_RAM]
[--reserved_ha_disk RESERVED_HA_DISK]
[--resources_share RESOURCES_SHARE]
arguments:
-h, --help show this help message and exit
--reserved_ha_cpu RESERVED_HA_CPU - Reserved HA CPU percent
--reserved_ha_ram RESERVED_HA_RAM - Reserved HA RAM percent
--reserved_ha_disk RESERVED_HA_DISK - Reserved HA Disk percent
--resources_share RESOURCES_SHARE - Cluster resource sharing (Default - no) ['yes', 'no']
Add reserved resources to nodes
aaa cluster resource reserved add
> aaa cluster resource reserved add [-h] [--overcommit_cpu OVERCOMMIT_CPU]
[--overcommit_ram OVERCOMMIT_RAM]
[--reserved_system_cpu RESERVED_SYSTEM_CPU]
[--reserved_system_ram RESERVED_SYSTEM_RAM]
[--reserved_system_disk RESERVED_SYSTEM_DISK]
--uuids UUIDS
arguments:
-h, --help show this help message and exit
--overcommit_cpu OVERCOMMIT_CPU - Overcommit CPU (float)
--overcommit_ram OVERCOMMIT_RAM - Overcommit RAM (float)
--reserved_system_cpu RESERVED_SYSTEM_CPU - Reserved CPU count
--reserved_system_ram RESERVED_SYSTEM_RAM - Reserved RAM count
--reserved_system_disk RESERVED_SYSTEM_DISK - Reserved Disk count
--uuids UUIDS - List of UUID nodes
Delete reserved resources from node
aaa cluster resource reserved del
> aaa cluster resource reserved del [-h] --uuids UUIDS
arguments:
-h, --help show this help message and exit
--uuids UUIDS - List of UUID nodes
Show reserved resources from node
aaa cluster resource reserved show
> aaa cluster resource reserved show [-h] --uuids UUIDS
arguments:
-h, --help show this help message and exit
--uuids UUIDS - List of UUID nodes
Update reserved resources to node
aaa cluster resource reserved update
> aaa cluster resource reserved update [-h] [--overcommit_cpu OVERCOMMIT_CPU]
[--overcommit_ram OVERCOMMIT_RAM]
[--reserved_system_cpu RESERVED_SYSTEM_CPU]
[--reserved_system_ram RESERVED_SYSTEM_RAM]
[--reserved_system_disk RESERVED_SYSTEM_DISK]
--uuid UUID
arguments:
-h, --help show this help message and exit
--overcommit_cpu OVERCOMMIT_CPU - Overcommit CPU (float)
--overcommit_ram OVERCOMMIT_RAM - Overcommit RAM (float)
--reserved_system_cpu RESERVED_SYSTEM_CPU - Reserved CPU count
--reserved_system_ram RESERVED_SYSTEM_RAM - Reserved RAM count
--reserved_system_disk RESERVED_SYSTEM_DISK - Reserved Disk count
--uuid UUID - Node UUID
View available RAM and CPU resources
aaa cluster resource show
Add new namespace (Virtual DC) to Cluster
aaa namespace add
> aaa namespace add [-h] --cluster CLUSTER
--ns NS
[--paths PATHS]
[--descr DESCR]
--vcpu VCPU
--vram VRAM
[--init_file INIT_FILE]
arguments:
-h, --help show this help message and exit
--cluster CLUSTER - Cluster name
--ns NS - Namespace name
--paths PATHS - Directory tree as JSON object
--descr DESCR - Namespace description
--vcpu VCPU - Virtual CPU
--vram VRAM - Virtual RAM
--init_file INIT_FILE - Path to namespace initial configuration file
Force delete namespace (Virtual DC) from Cluster
aaa namespace clear
> aaa namespace clear [-h] --cluster CLUSTER
--ns NS
arguments:
-h, --help show this help message and exit
--cluster CLUSTER - Cluster name
--ns NS - Namespace name
Delete namespace (Virtual DC) from Cluster
aaa namespace del
> aaa namespace del [-h] --ns NS
--cluster CLUSTER
[--force FORCE]
arguments:
-h, --help show this help message and exit
--ns NS - Namespace to delete
--cluster CLUSTER - Cluster containing namespace to be deleted
--force FORCE - Provide the name of the namespace to force-delete it
List namespaces (Virtual DC) from Cluster
aaa namespace list
> aaa namespace list [-h] --cluster CLUSTER
arguments:
-h, --help show this help message and exit
--cluster CLUSTER - Cluster name
Present paths structure of namespace
aaa namespace path show
Update paths of current namespace (Virtual DC)
aaa namespace path update
> aaa namespace path update [-h] [--paths PATHS]
arguments:
-h, --help show this help message and exit
--paths PATHS - Directory tree as JSON object
Show namespace (Virtual DC) from Cluster
aaa namespace show
> aaa namespace show [-h] --cluster CLUSTER
--ns NS
arguments:
-h, --help show this help message and exit
--cluster CLUSTER - Cluster name
--ns NS - Namespace name
Update namespace (Virtual DC) to Cluster
aaa namespace update
> aaa namespace update [-h] --cluster CLUSTER
--ns NS
[--paths PATHS]
[--descr DESCR]
[--vcpu VCPU]
[--vram VRAM]
arguments:
-h, --help show this help message and exit
--cluster CLUSTER - Cluster name
--ns NS - Namespace name
--paths PATHS - Directory tree as JSON object
--descr DESCR - Namespace description
--vcpu VCPU - Virtual CPU
--vram VRAM - Virtual RAM
Add AAA params
aaa param add
> aaa param add [-h] [--auth_type AUTH_TYPE]
[--cert CERT]
[--ldap LDAP]
[--ldap_sync LDAP_SYNC]
[--validation_ip VALIDATION_IP]
[--acc_delete_days ACC_DELETE_DAYS]
[--acc_block_unused_days ACC_BLOCK_UNUSED_DAYS]
[--acc_block_try_cnt ACC_BLOCK_TRY_CNT]
[--acc_block_try_timeout_sec ACC_BLOCK_TRY_TIMEOUT_SEC]
[--acc_block_try_suspend_sec ACC_BLOCK_TRY_SUSPEND_SEC]
[--sessions_max_cnt SESSIONS_MAX_CNT]
[--sessions_timeout_sec SESSIONS_TIMEOUT_SEC]
[--password_pattern PASSWORD_PATTERN]
[--password_salt PASSWORD_SALT]
[--password_diff_cnt PASSWORD_DIFF_CNT]
[--password_exp_days PASSWORD_EXP_DAYS]
[--password_min_exp_days PASSWORD_MIN_EXP_DAYS]
[--password_min_change PASSWORD_MIN_CHANGE]
[--require_generated_password_change REQUIRE_GENERATED_PASSWORD_CHANGE]
[--whitelist_networks WHITELIST_NETWORKS]
[--tfa_client TFA_CLIENT]
[--tfa_wait_sec TFA_WAIT_SEC]
[--notif_route NOTIF_ROUTE]
[--ns_owner_access NS_OWNER_ACCESS]
arguments:
-h, --help show this help message and exit
--auth_type AUTH_TYPE - Auth type (default - BASIC) ['BASIC', 'TFA']
--cert CERT - Using cert for verify users connections ['yes', 'no']
--ldap LDAP - LDAP config name
--ldap_sync LDAP_SYNC - Sync data from LDAP server (default - no) ['yes', 'no']
--validation_ip VALIDATION_IP - Check client network adress (default - no) ['yes', 'no']
--acc_delete_days ACC_DELETE_DAYS - Days after completly delete account (default - 45 days)
--acc_block_unused_days ACC_BLOCK_UNUSED_DAYS - Days after block unused account (default - 45 days)
--acc_block_try_cnt ACC_BLOCK_TRY_CNT - Try login count before suspend (default - 3)
--acc_block_try_timeout_sec ACC_BLOCK_TRY_TIMEOUT_SEC - Try login interval counting (default - 5 min)
--acc_block_try_suspend_sec ACC_BLOCK_TRY_SUSPEND_SEC - Try login suspend timeout (default - 60 min)
--sessions_max_cnt SESSIONS_MAX_CNT - Max number of user sessions (default - 2)
--sessions_timeout_sec SESSIONS_TIMEOUT_SEC - Session timeout (default - 3 min)
--password_pattern PASSWORD_PATTERN - Password regexp pattern (default - min 8 + UpperCase + LowerCase + Number + Spec char )
--password_salt PASSWORD_SALT - Additional password salt (default - empty)
--password_diff_cnt PASSWORD_DIFF_CNT - Password difference count char (default - 4)
--password_exp_days PASSWORD_EXP_DAYS - Password expiration period (default - 60 days)
--password_min_exp_days PASSWORD_MIN_EXP_DAYS - Password min expiration period (default - 10 days)
--password_min_change PASSWORD_MIN_CHANGE - Password min change count symbols (default - 2)
--require_generated_password_change REQUIRE_GENERATED_PASSWORD_CHANGE - Is possible to enter in namespace by user with generated password ['yes', 'no']
--whitelist_networks WHITELIST_NETWORKS - List of white networks
--tfa_client TFA_CLIENT - TFA Client factor (default - OTP) ['OTP']
--tfa_wait_sec TFA_WAIT_SEC - TFA timeout (default - 1 min)
--notif_route NOTIF_ROUTE - Route name for notifications
--ns_owner_access NS_OWNER_ACCESS - Namespace owner access (default - yes) ['yes', 'no']
Disable checks
aaa param check disable
Enable checks
aaa param check enable
Delete AAA params
aaa param del
Add LDAP config
aaa param ldap add
> aaa param ldap add [-h] --name NAME
[--url URL]
[--ca_data CA_DATA]
[--ca_file CA_FILE]
[--user USER]
[--passwd PASSWD]
[--base_dn BASE_DN]
[--query_group QUERY_GROUP]
[--query_user QUERY_USER]
[--query_active_users QUERY_ACTIVE_USERS]
[--user_map USER_MAP]
[--group_map GROUP_MAP]
[--default_path DEFAULT_PATH]
[--notif_route NOTIF_ROUTE]
[--error_limit ERROR_LIMIT]
arguments:
-h, --help show this help message and exit
--name NAME - Config name
--url URL - Server URL
--ca_data CA_DATA - Ldap server certificate contents
--ca_file CA_FILE - Ldap server certificate
--user USER - Service user
--passwd PASSWD - Service passwd
--base_dn BASE_DN - LDAP base DN
--query_group QUERY_GROUP - LDAP query to get groups
--query_user QUERY_USER - LDAP query to get users
--query_active_users QUERY_ACTIVE_USERS - LDAP query to get active users
--user_map USER_MAP - User mapping attributes
--group_map GROUP_MAP - Group mapping attributes
--default_path DEFAULT_PATH - Default path for loaded users
--notif_route NOTIF_ROUTE - Route name for send notifications about LDAP errors
--error_limit ERROR_LIMIT - Limit the number of LDAP errors before will be send notification
Delete LDAP config
aaa param ldap del
> aaa param ldap del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Config name
List LDAP config
aaa param ldap list
Show LDAP config
aaa param ldap show
> aaa param ldap show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Config name
Update LDAP config
aaa param ldap update
> aaa param ldap update [-h] --name NAME
[--url URL]
[--ca_data CA_DATA]
[--ca_file CA_FILE]
[--user USER]
[--passwd PASSWD]
[--base_dn BASE_DN]
[--query_group QUERY_GROUP]
[--query_user QUERY_USER]
[--query_active_users QUERY_ACTIVE_USERS]
[--user_map USER_MAP]
[--group_map GROUP_MAP]
[--default_path DEFAULT_PATH]
[--notif_route NOTIF_ROUTE]
[--error_limit ERROR_LIMIT]
arguments:
-h, --help show this help message and exit
--name NAME - Config name
--url URL - Server URL
--ca_data CA_DATA - Ldap server certificate contents
--ca_file CA_FILE - Ldap server certificate
--user USER - Service user
--passwd PASSWD - Service passwd
--base_dn BASE_DN - LDAP base DN
--query_group QUERY_GROUP - LDAP query to get groups
--query_user QUERY_USER - LDAP query to get users
--query_active_users QUERY_ACTIVE_USERS - LDAP query to get active users
--user_map USER_MAP - User mapping attributes
--group_map GROUP_MAP - Group mapping attributes
--default_path DEFAULT_PATH - Default path for loaded users
--notif_route NOTIF_ROUTE - Route name for send notifications about LDAP errors
--error_limit ERROR_LIMIT - Limit the number of LDAP errors before will be send notification
Show AAA params
aaa param show
Update AAA params
aaa param update
> aaa param update [-h] [--auth_type AUTH_TYPE]
[--cert CERT]
[--ldap LDAP]
[--ldap_sync LDAP_SYNC]
[--validation_ip VALIDATION_IP]
[--acc_delete_days ACC_DELETE_DAYS]
[--acc_block_unused_days ACC_BLOCK_UNUSED_DAYS]
[--acc_block_try_cnt ACC_BLOCK_TRY_CNT]
[--acc_block_try_timeout_sec ACC_BLOCK_TRY_TIMEOUT_SEC]
[--acc_block_try_suspend_sec ACC_BLOCK_TRY_SUSPEND_SEC]
[--sessions_max_cnt SESSIONS_MAX_CNT]
[--sessions_timeout_sec SESSIONS_TIMEOUT_SEC]
[--password_pattern PASSWORD_PATTERN]
[--password_salt PASSWORD_SALT]
[--password_diff_cnt PASSWORD_DIFF_CNT]
[--password_exp_days PASSWORD_EXP_DAYS]
[--password_min_exp_days PASSWORD_MIN_EXP_DAYS]
[--password_min_change PASSWORD_MIN_CHANGE]
[--require_generated_password_change REQUIRE_GENERATED_PASSWORD_CHANGE]
[--whitelist_networks WHITELIST_NETWORKS]
[--tfa_client TFA_CLIENT]
[--tfa_wait_sec TFA_WAIT_SEC]
[--otp_code_live_period_years OTP_CODE_LIVE_PERIOD_YEARS]
[--notif_route NOTIF_ROUTE]
[--ns_owner_access NS_OWNER_ACCESS]
arguments:
-h, --help show this help message and exit
--auth_type AUTH_TYPE - Auth type (default - BASIC) ['BASIC', 'TFA']
--cert CERT - Using cert for verify users connections ['yes', 'no']
--ldap LDAP - LDAP config name
--ldap_sync LDAP_SYNC - Sync data from LDAP server (default - no) ['yes', 'no']
--validation_ip VALIDATION_IP - Check client network adress (default - no) ['yes', 'no']
--acc_delete_days ACC_DELETE_DAYS - Days after completly delete account (default - 45 days)
--acc_block_unused_days ACC_BLOCK_UNUSED_DAYS - Days after block unused account (default - 45 days)
--acc_block_try_cnt ACC_BLOCK_TRY_CNT - Try login count before suspend (default - 3)
--acc_block_try_timeout_sec ACC_BLOCK_TRY_TIMEOUT_SEC - Try login interval counting (default - 5 min)
--acc_block_try_suspend_sec ACC_BLOCK_TRY_SUSPEND_SEC - Try login suspend timeout (default - 60 min)
--sessions_max_cnt SESSIONS_MAX_CNT - Max number of user sessions (default - 2)
--sessions_timeout_sec SESSIONS_TIMEOUT_SEC - Session timeout (default - 3 min)
--password_pattern PASSWORD_PATTERN - Password regexp pattern (default - min 8 + UpperCase + LowerCase + Number + Spec char )
--password_salt PASSWORD_SALT - Additional password salt (default - empty)
--password_diff_cnt PASSWORD_DIFF_CNT - Password difference count char (default - 4)
--password_exp_days PASSWORD_EXP_DAYS - Password expiration period (default - 60 days)
--password_min_exp_days PASSWORD_MIN_EXP_DAYS - Password min expiration period (default - 10 days)
--password_min_change PASSWORD_MIN_CHANGE - Password min change count symbols (default - 2)
--require_generated_password_change REQUIRE_GENERATED_PASSWORD_CHANGE - Is possible to enter in namespace by user with generated password ['yes', 'no']
--whitelist_networks WHITELIST_NETWORKS - List of white networks
--tfa_client TFA_CLIENT - TFA Client factor (default - OTP) ['OTP']
--tfa_wait_sec TFA_WAIT_SEC - TFA timeout (default - 1 min)
--otp_code_live_period_years OTP_CODE_LIVE_PERIOD_YEARS - The time period from the moment the OTP-code is installed when it will be valid (in years)
--notif_route NOTIF_ROUTE - Route name for notifications
--ns_owner_access NS_OWNER_ACCESS - Namespace owner access (default - yes) ['yes', 'no']
Add new permissions
aaa permissions add
> aaa permissions add [-h] --name NAME
--data DATA
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Permission name
--data DATA - Permissions data
--descr DESCR - Permission description
Delete permissions
aaa permissions del
> aaa permissions del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Permission name
Show available permissions
aaa permissions desc
> aaa permissions desc [-h] [--filter FILTER]
arguments:
-h, --help show this help message and exit
--filter FILTER - Permission filter
List permissions
aaa permissions list
Show permissions
aaa permissions show
> aaa permissions show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Permission name
Add new role
aaa role add
> aaa role add [-h] --role ROLE
--permissions PERMISSIONS
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--role ROLE - Role name
--permissions PERMISSIONS - Permission groups
--descr DESCR - Role description
Delete role
aaa role del
> aaa role del [-h] --role ROLE
arguments:
-h, --help show this help message and exit
--role ROLE - Role name
List roles
aaa role list
Show role
aaa role show
> aaa role show [-h] --role ROLE
arguments:
-h, --help show this help message and exit
--role ROLE - Role name
Update role
aaa role update
> aaa role update [-h] --role ROLE
[--permissions PERMISSIONS]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--role ROLE - Role name
--permissions PERMISSIONS - Permission groups
--descr DESCR - Role description
Delete session
aaa session del
> aaa session del [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Session UUID
List sessions
aaa session list
Add new user
aaa user add
> aaa user add [-h] --login LOGIN
[--path PATH]
[--email EMAIL]
[--whitelist_networks WHITELIST_NETWORKS]
[--roles ROLES]
[--descr DESCR]
[--passwd PASSWD]
arguments:
-h, --help show this help message and exit
--login LOGIN - User login
--path PATH - User path
--email EMAIL - User email
--whitelist_networks WHITELIST_NETWORKS - List of white networks
--roles ROLES - User roles
--descr DESCR - User description
--passwd PASSWD - User password
Send namespace cert to user(s)
aaa user cert notify
> aaa user cert notify [-h] --login LOGIN
arguments:
-h, --help show this help message and exit
--login LOGIN - User login
Update user certificate
aaa user cert update
Delete user (force delete user data)
aaa user clear
> aaa user clear [-h] --login LOGIN
arguments:
-h, --help show this help message and exit
--login LOGIN - User login
Delete user
aaa user del
> aaa user del [-h] --login LOGIN
arguments:
-h, --help show this help message and exit
--login LOGIN - User login
List users
aaa user list
Delete yourself OTP token
aaa user otp del
Delete OTP token of user
aaa user otp user del
> aaa user otp user del [-h] --login LOGIN
arguments:
-h, --help show this help message and exit
--login LOGIN - User login whose otp-code needs to be deleted
Update your email or password
aaa user param update
> aaa user param update [-h] [--email EMAIL]
[--passwd PASSWD]
[--prev_passwd PREV_PASSWD]
arguments:
-h, --help show this help message and exit
--email EMAIL - User email
--passwd PASSWD - User password
--prev_passwd PREV_PASSWD - User last password
Update user path
aaa user path update
> aaa user path update [-h] --login LOGIN
--path PATH
arguments:
-h, --help show this help message and exit
--login LOGIN - User login
--path PATH - User path
Show user
aaa user show
> aaa user show [-h] [--login LOGIN]
arguments:
-h, --help show this help message and exit
--login LOGIN - User login
Update user status
aaa user status update
> aaa user status update [-h] --login LOGIN
--status STATUS
arguments:
-h, --help show this help message and exit
--login LOGIN - User login
--status STATUS - User status ['ACTIVE', 'BLOCKED']
Update user
aaa user update
> aaa user update [-h] --login LOGIN
[--email EMAIL]
[--roles ROLES]
[--descr DESCR]
[--passwd PASSWD]
[--prev_passwd PREV_PASSWD]
[--cert CERT]
arguments:
-h, --help show this help message and exit
--login LOGIN - User login
--email EMAIL - User email
--roles ROLES - User roles
--descr DESCR - User description
--passwd PASSWD - User password
--prev_passwd PREV_PASSWD - User last password
--cert CERT - Update user cert ['yes', 'no']
Update user whielist networks
aaa user whitelist update
> aaa user whitelist update [-h] --login LOGIN
--whitelist_networks WHITELIST_NETWORKS
arguments:
-h, --help show this help message and exit
--login LOGIN - User login
--whitelist_networks WHITELIST_NETWORKS - List of white networks
aaaevents plugin
Set notif route used if case there is not enough space for storing security events. Running without params returns current route used
aaaevents archive freespacelimitnotifroute
> aaaevents archive freespacelimitnotifroute [-h] [--setroute SETROUTE]
arguments:
-h, --help show this help message and exit
--setroute SETROUTE - Notif route used for lack of free space notification. Use None to switch it off
Make aaaevents archive file manually (all events to be deleted from aaaevents log)
aaaevents archive make
> aaaevents archive make [-h] --up_to_date UP_TO_DATE
arguments:
-h, --help show this help message and exit
--up_to_date UP_TO_DATE - all the events in the log up to the desired date to be archived format yyyy-mm-dd (ex. 2023-10-13) for date UTC timezone or negative integer (ex. -10) to provide offset from current date
Show event defaults
aaaevents event defaults
Show avaliable events
aaaevents event desc
> aaaevents event desc [-h] [--filter FILTER]
arguments:
-h, --help show this help message and exit
--filter FILTER - Plugin filter
List user events
aaaevents event list
> aaaevents event list [-h] [--operation OPERATION]
[--group GROUP]
[--level LEVEL]
[--login LOGIN]
[--limit LIMIT]
[--begin BEGIN]
[--end END]
[--full FULL]
arguments:
-h, --help show this help message and exit
--operation OPERATION - Operation name
--group GROUP - Event group name
--level LEVEL - Event level name
--login LOGIN - User/login name
--limit LIMIT - Number of events
--begin BEGIN - Start date (d/m/Y, H:M:S)
--end END - End date (d/m/Y, H:M:S)
--full FULL - Show full events message ['yes', 'no']
Set minimal level of events to be logged. Running without params returns current level (default - INFO)
aaaevents event loglevel
> aaaevents event loglevel [-h] [--setlevel SETLEVEL]
arguments:
-h, --help show this help message and exit
--setlevel SETLEVEL - Minimal level of events to be saved ['INFO', 'WARN', 'CRITICAL']
Show user event
aaaevents event show
> aaaevents event show [-h] [--login LOGIN]
--uuid UUID
arguments:
-h, --help show this help message and exit
--login LOGIN - User/login name
--uuid UUID - Event UUID
Show available event types
aaaevents event types
Add AAA Events params
aaaevents param add
> aaaevents param add [-h] [--ttl_days TTL_DAYS]
[--events_params EVENTS_PARAMS]
arguments:
-h, --help show this help message and exit
--ttl_days TTL_DAYS - TTL in days for events (must be in [92, 1096] range)
--events_params EVENTS_PARAMS - Events parameters (group, level, prop)
Delete AAA events params
aaaevents param del
Show AAA Events params
aaaevents param show
Update AAA Events params
aaaevents param update
> aaaevents param update [-h] [--ttl_days TTL_DAYS]
[--events_params EVENTS_PARAMS]
arguments:
-h, --help show this help message and exit
--ttl_days TTL_DAYS - TTL in days for events (must be in [92, 1096] range)
--events_params EVENTS_PARAMS - Events parameters (group, level, prop)
Add new syslog connection configuration
aaaevents syslog add
> aaaevents syslog add [-h] --protocol PROTOCOL
--address ADDRESS
[--port PORT]
[--use_tls USE_TLS]
[--ca_data CA_DATA]
[--ca_file CA_FILE]
[--log_enabled LOG_ENABLED]
arguments:
-h, --help show this help message and exit
--protocol PROTOCOL - protocol to use when logging to syslog
--address ADDRESS - syslog server address
--port PORT - syslog server connection port
--use_tls USE_TLS - use secure connection to syslog server
--ca_data CA_DATA - CA file content
--ca_file CA_FILE - path to CA file
--log_enabled LOG_ENABLED - enable logging to syslog server
Delete syslog connection configuration
aaaevents syslog del
Show syslog connection configuration
aaaevents syslog show
Update syslog connection configuration
aaaevents syslog update
> aaaevents syslog update [-h] [--protocol PROTOCOL]
[--address ADDRESS]
[--port PORT]
[--use_tls USE_TLS]
[--ca_data CA_DATA]
[--ca_file CA_FILE]
[--log_enabled LOG_ENABLED]
arguments:
-h, --help show this help message and exit
--protocol PROTOCOL - protocol to use when logging to syslog
--address ADDRESS - syslog server address
--port PORT - port
--use_tls USE_TLS - use secure connection to syslog server
--ca_data CA_DATA - CA file content
--ca_file CA_FILE - path to CA file
--log_enabled LOG_ENABLED - enable logging to syslog server
goss plugin
Add goss check
goss global check add
> goss global check add [-h] --name NAME
[--descr DESCR]
[--data DATA]
[--hook_data HOOK_DATA]
[--cron CRON]
[--run_code RUN_CODE]
arguments:
-h, --help show this help message and exit
--name NAME - Check name
--descr DESCR - Check description
--data DATA - Check data
--hook_data HOOK_DATA - Hook data
--cron CRON - CRON schedule
--run_code RUN_CODE - Run strategy (default - VIP) ['VIP', 'ALL']
Delete goss check
goss global check del
> goss global check del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Check name
List goss check
goss global check list
Run check
goss global check run
> goss global check run [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Check name
Show goss check
goss global check show
> goss global check show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Check name
Update goss check
goss global check update
> goss global check update [-h] --name NAME
[--descr DESCR]
[--data DATA]
[--hook_data HOOK_DATA]
[--cron CRON]
[--run_code RUN_CODE]
arguments:
-h, --help show this help message and exit
--name NAME - Check name
--descr DESCR - Check description
--data DATA - Check data
--hook_data HOOK_DATA - Hook data
--cron CRON - CRON schedule
--run_code RUN_CODE - Run strategy (default - VIP) ['VIP', 'ALL']
List goss events
goss global event list
> goss global event list [-h] [--limit LIMIT]
arguments:
-h, --help show this help message and exit
--limit LIMIT - Limit count events
Show event
goss global event show
> goss global event show [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Uuid of the event
hardware plugin
List hardware events
hardware event list
> hardware event list [-h] --server_id SERVER_ID
--event_id EVENT_ID
[--limit LIMIT]
arguments:
-h, --help show this help message and exit
--server_id SERVER_ID - Node UUID
--event_id EVENT_ID - Event ID name
--limit LIMIT - Limit count events
ipam plugin
Add ACLs rules
ipam acl add
> ipam acl add [-h] --data DATA
arguments:
-h, --help show this help message and exit
--data DATA - ACLs rules as JSON string
Del ACL rule
ipam acl del
> ipam acl del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - ACL name
List ACLs rules
ipam acl list
Show ACLs rules
ipam acl show
> ipam acl show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - ACL name
Update ACLs rules
ipam acl update
> ipam acl update [-h] --name NAME
--data DATA
arguments:
-h, --help show this help message and exit
--name NAME - ACL name
--data DATA - ACLs rules as JSON string
List allocated ip in vnet
ipam addr allocated list
> ipam addr allocated list [-h] --vnet_name VNET_NAME
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
List free ip in vnet
ipam addr free list
> ipam addr free list [-h] --vnet_name VNET_NAME
[--full_output FULL_OUTPUT]
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--full_output FULL_OUTPUT - {{ no such element: dict object['desc'] }}
Add virtual ip
ipam addr virtual add
> ipam addr virtual add [-h] --vnet_name VNET_NAME
--ip IP
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--ip IP - Virtual IP
Del virtual ip
ipam addr virtual del
> ipam addr virtual del [-h] --vnet_name VNET_NAME
--ip IP
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--ip IP - Virtual IP
List virtual ip
ipam addr virtual list
> ipam addr virtual list [-h] --vnet_name VNET_NAME
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
Add ACLs to iface
ipam iface acls add
> ipam iface acls add [-h] --vnet_name VNET_NAME
--mac MAC
--acls ACLS
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--mac MAC - Iface MAC address
--acls ACLS - List of ACLs names
Delete ACLs from iface
ipam iface acls del
> ipam iface acls del [-h] --vnet_name VNET_NAME
--mac MAC
--acls ACLS
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--mac MAC - Iface MAC address
--acls ACLS - List of ACLs names
Add IPAM iface
ipam iface add
> ipam iface add [-h] --vnet_name VNET_NAME
--vm_uuid VM_UUID
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--vm_uuid VM_UUID - VM uuid
Del IPAM iface
ipam iface del
> ipam iface del [-h] --vnet_name VNET_NAME
--mac MAC
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--mac MAC - Iface MAC
List IPAM ifaces
ipam iface list
> ipam iface list [-h] --vnet_name VNET_NAME
[--show_acl SHOW_ACL]
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--show_acl SHOW_ACL - show acls attached to iface
Add ACLs to network
ipam network acls add
> ipam network acls add [-h] --vnet_name VNET_NAME
--acls ACLS
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--acls ACLS - List of ACLs names
Delete ACLs from network
ipam network acls del
> ipam network acls del [-h] --vnet_name VNET_NAME
--acls ACLS
arguments:
-h, --help show this help message and exit
--vnet_name VNET_NAME - Network name
--acls ACLS - List of ACLs names
Add IPAM network
ipam network add
> ipam network add [-h] --name NAME
[--ns NS]
--net_type NET_TYPE
--ipv IPV
[--vxlan_vni VXLAN_VNI]
--vlan VLAN
[--mtu MTU]
--v4_net V4_NET
[--v4_pref V4_PREF]
[--v4_mask V4_MASK]
[--v4_start V4_START]
[--v4_end V4_END]
[--v4_gw V4_GW]
[--v4_dns1 V4_DNS1]
[--v4_dns2 V4_DNS2]
[--v6_dns1 V6_DNS1]
[--v6_dns2 V6_DNS2]
[--v6_np V6_NP]
[--v6_gw V6_GW]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Network name
--ns NS - Target namespace
--net_type NET_TYPE - Network type ['vlan', 'vxlan']
--ipv IPV - Network IP version ['4', '6']
--vxlan_vni VXLAN_VNI - Vxlan vni
--vlan VLAN - Vlan id
--mtu MTU - MTU size
--v4_net V4_NET - IPv4 network
--v4_pref V4_PREF - IPv4 network prefix
--v4_mask V4_MASK - IPv4 network mask
--v4_start V4_START - IPv4 network start address
--v4_end V4_END - IPv4 network end address
--v4_gw V4_GW - IPv4 network gateway address
--v4_dns1 V4_DNS1 - IPv4 dns
--v4_dns2 V4_DNS2 - IPv4 dns
--v6_dns1 V6_DNS1 - IPv6 dns
--v6_dns2 V6_DNS2 - IPv6 dns
--v6_np V6_NP - IPv6 network np
--v6_gw V6_GW - IPv6 network gateway address
--descr DESCR - Description
Delete IPAM network
ipam network del
> ipam network del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Network name
List IPAM networks
ipam network list
> ipam network list [-h] [--show_acl SHOW_ACL]
arguments:
-h, --help show this help message and exit
--show_acl SHOW_ACL - should show acls
Show IPAM network
ipam network show
> ipam network show [-h] --name NAME
[--show_acl SHOW_ACL]
arguments:
-h, --help show this help message and exit
--name NAME - Network name
--show_acl SHOW_ACL - should show acls
Update IPAM network
ipam network update
> ipam network update [-h] --name NAME
[--ns NS]
[--mtu MTU]
[--v4_gw V4_GW]
[--v6_gw V6_GW]
[--descr DESCR]
[--v4_start V4_START]
[--v4_end V4_END]
[--v4_dns1 V4_DNS1]
[--v4_dns2 V4_DNS2]
arguments:
-h, --help show this help message and exit
--name NAME - Network name
--ns NS - Target namespace
--mtu MTU - MTU size
--v4_gw V4_GW - IPv4 network gateway address
--v6_gw V6_GW - IPv6 network gateway address
--descr DESCR - Description
--v4_start V4_START - IPv4 network start address
--v4_end V4_END - IPv4 network end address
--v4_dns1 V4_DNS1 - IPv4 dns
--v4_dns2 V4_DNS2 - IPv4 dns
Add IPAM params
ipam param add
> ipam param add [-h] --mac_prefix MAC_PREFIX
[--ipv6_group IPV6_GROUP]
--allocated_vlans ALLOCATED_VLANS
--reserved_vlans RESERVED_VLANS
[--reserved_v4_nets RESERVED_V4_NETS]
[--mtu MTU]
--bridge BRIDGE
arguments:
-h, --help show this help message and exit
--mac_prefix MAC_PREFIX - List of MACs
--ipv6_group IPV6_GROUP - IPv6 group
--allocated_vlans ALLOCATED_VLANS - List of allocated vlans
--reserved_vlans RESERVED_VLANS - List of reserved vlans
--reserved_v4_nets RESERVED_V4_NETS - List of reserved ipv4 /24 networks
--mtu MTU - MTU size
--bridge BRIDGE - Bridge interface
Delete IPAM params
ipam param del
Show IPAM params
ipam param show
Update IPAM params
ipam param update
> ipam param update [-h] [--mac_prefix MAC_PREFIX]
[--ipv6_group IPV6_GROUP]
[--allocated_vlans ALLOCATED_VLANS]
[--reserved_vlans RESERVED_VLANS]
[--reserved_v4_nets RESERVED_V4_NETS]
[--v4_gw V4_GW]
[--mtu MTU]
[--bridge BRIDGE]
arguments:
-h, --help show this help message and exit
--mac_prefix MAC_PREFIX - List of MACs
--ipv6_group IPV6_GROUP - IPv6 group
--allocated_vlans ALLOCATED_VLANS - List of allocated vlans
--reserved_vlans RESERVED_VLANS - List of reserved vlans
--reserved_v4_nets RESERVED_V4_NETS - List of reserved ipv4 /24 networks
--v4_gw V4_GW - IPv4 network gateway address
--mtu MTU - MTU size
--bridge BRIDGE - Bridge interface
lic plugin
Add license to product
lic license add
> lic license add [-h] --content CONTENT
arguments:
-h, --help show this help message and exit
--content CONTENT - license content
Remove license
lic license remove
> lic license remove [-h] --force FORCE
arguments:
-h, --help show this help message and exit
--force FORCE - fill with cluster name to ensure you understand what you are doing
Show license data
lic license show
Update product license
lic license update
> lic license update [-h] --content CONTENT
arguments:
-h, --help show this help message and exit
--content CONTENT - license content
Shows cluster registration info, used for requesting a license and licensing checks
lic registration info
Generates data required to acquire the product license
lic registration requestdata
logdump plugin
Add export task
logdump export add
> logdump export add [-h] --node NODE
[--pre_exec PRE_EXEC]
[--post_exec POST_EXEC]
[--db DB]
[--sosreport SOSREPORT]
[--path PATH]
[--passwd PASSWD]
[--delete_after DELETE_AFTER]
arguments:
-h, --help show this help message and exit
--node NODE - Node names
--pre_exec PRE_EXEC - List of pre commands
--post_exec POST_EXEC - List of post commands
--db DB - Should DB state be exported? ['yes', 'no']
--sosreport SOSREPORT - Should sosreport file be exported? ['yes', 'no']
--path PATH - Path to the dir where the archive will be exported to
--passwd PASSWD - Password for the exported archive
--delete_after DELETE_AFTER - Date or number of days after which the archive will be deleted
Clear export task
logdump export clear
> logdump export clear [-h] --uuid UUID
[--node NODE]
arguments:
-h, --help show this help message and exit
--uuid UUID - Task UUID
--node NODE - Node UUID
List all export tasks
logdump export list
Add Exports params
logdump export param add
> logdump export param add [-h] [--pre_exec PRE_EXEC]
[--post_exec POST_EXEC]
[--db DB]
[--sosreport SOSREPORT]
[--path PATH]
[--passwd PASSWD]
arguments:
-h, --help show this help message and exit
--pre_exec PRE_EXEC - List of pre commands
--post_exec POST_EXEC - List of post commands
--db DB - Should DB state be exported? ['yes', 'no']
--sosreport SOSREPORT - Should sosreport file be exported? ['yes', 'no']
--path PATH - Path to the dir where the archive will be exported to
--passwd PASSWD - Password for the exported archive
Delete Exports params
logdump export param del
Show Exports params
logdump export param show
Update Exports params
logdump export param update
> logdump export param update [-h] [--pre_exec PRE_EXEC]
[--post_exec POST_EXEC]
[--db DB]
[--sosreport SOSREPORT]
[--path PATH]
[--passwd PASSWD]
arguments:
-h, --help show this help message and exit
--pre_exec PRE_EXEC - List of pre commands
--post_exec POST_EXEC - List of post commands
--db DB - Should DB state be exported? ['yes', 'no']
--sosreport SOSREPORT - Should sosreport file be exported? ['yes', 'no']
--path PATH - Path to the dir where the archive will be exported to
--passwd PASSWD - Password for the exported archive
Show export task
logdump export show
> logdump export show [-h] --uuid UUID
[--node NODE]
arguments:
-h, --help show this help message and exit
--uuid UUID - Task UUID
--node NODE - Node UUID
Add import task
logdump import add
> logdump import add [-h] --node NODE
[--pre_exec PRE_EXEC]
[--post_exec POST_EXEC]
[--zip ZIP]
arguments:
-h, --help show this help message and exit
--node NODE - Node names
--pre_exec PRE_EXEC - List of pre commands
--post_exec POST_EXEC - List of post commands
--zip ZIP - Zip file name
Clear import task
logdump import clear
> logdump import clear [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Task UUID
List all imports tasks
logdump import list
Add Imports params
logdump import param add
> logdump import param add [-h] [--pre_exec PRE_EXEC]
[--post_exec POST_EXEC]
arguments:
-h, --help show this help message and exit
--pre_exec PRE_EXEC - List of pre commands
--post_exec POST_EXEC - List of post commands
Delete Imports params
logdump import param del
Show Imports params
logdump import param show
Update Imports params
logdump import param update
> logdump import param update [-h] [--pre_exec PRE_EXEC]
[--post_exec POST_EXEC]
arguments:
-h, --help show this help message and exit
--pre_exec PRE_EXEC - List of pre commands
--post_exec POST_EXEC - List of post commands
Show import task
logdump import show
> logdump import show [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Task UUID
trace
logdump trace
> logdump trace [-h] --trace_token TRACE_TOKEN
arguments:
-h, --help show this help message and exit
--trace_token TRACE_TOKEN - trace_token
metrics plugin
Metric data fetch from database
metrics data fetch
> metrics data fetch [-h] --name NAME
--sc_node SC_NODE
[--filters FILTERS]
[--current CURRENT]
arguments:
-h, --help show this help message and exit
--name NAME - Exporter name.
--sc_node SC_NODE - UUID node
--filters FILTERS - Filtering metrics name and labels
--current CURRENT - Current metric or all available metrics. ['yes', 'no']
Add configuration exporter
metrics exporter add
> metrics exporter add [-h] --name NAME
--port PORT
[--metrics_path METRICS_PATH]
[--nodes NODES]
[--retention_period RETENTION_PERIOD]
[--filters FILTERS]
[--cron CRON]
arguments:
-h, --help show this help message and exit
--name NAME - Exporter name.
--port PORT - Port to listen on for web interface and telemetry.
--metrics_path METRICS_PATH - The path to take metrics. (default: /metrics)
--nodes NODES - Selecting nodes that should collect metrics.
--retention_period RETENTION_PERIOD - Retention period in seconds. (default: 600)
--filters FILTERS - Filtering metrics name and labels
--cron CRON - Cron expression to run exporter.
Delete configuration exporter
metrics exporter del
> metrics exporter del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Exporter name.
List configuration exporter
metrics exporter list
Show configuration exporter
metrics exporter show
> metrics exporter show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Exporter name.
Update configuration exporter
metrics exporter update
> metrics exporter update [-h] --name NAME
[--port PORT]
[--metrics_path METRICS_PATH]
[--nodes NODES]
[--retention_period RETENTION_PERIOD]
[--filters FILTERS]
[--cron CRON]
arguments:
-h, --help show this help message and exit
--name NAME - Exporter name.
--port PORT - Port to listen on for web interface and telemetry.
--metrics_path METRICS_PATH - The path to take metrics.
--nodes NODES - Selecting nodes that should collect metrics
--retention_period RETENTION_PERIOD - Retention period in seconds
--filters FILTERS - Filtering metrics name and labels
--cron CRON - Cron expression to run exporter.
Add a template
metrics template add
> metrics template add [-h] --name NAME
[--data DATA]
arguments:
-h, --help show this help message and exit
--name NAME - Template name.
--data DATA - Template data.
Delete a template
metrics template del
> metrics template del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Template name.
Execute template
metrics template execute
> metrics template execute [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Template name.
List templates
metrics template list
Show template
metrics template show
> metrics template show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Template name.
Update configuration exporter
metrics template update
> metrics template update [-h] --name NAME
[--data DATA]
arguments:
-h, --help show this help message and exit
--name NAME - Template name.
--data DATA - Template data.
notif plugin
Add notif Endpoint
notif endpoint add
> notif endpoint add [-h] --name NAME
[--type TYPE]
--url URL
[--tls TLS]
[--user USER]
[--passwd PASSWD]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Endpoint name
--type TYPE - Endpoint type (default - SMTP) ['SMTP']
--url URL - Server url
--tls TLS - Enable tls (default - no) ['yes', 'no']
--user USER - Service server user
--passwd PASSWD - Service server password
--descr DESCR - Endpoint description
Delete notif Endpoint
notif endpoint del
> notif endpoint del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Endpoint name
List notif Endpoints
notif endpoint list
Show notif Endpoint
notif endpoint show
> notif endpoint show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Endpoint name
Update notif Endpoint
notif endpoint update
> notif endpoint update [-h] --name NAME
[--url URL]
[--tls TLS]
[--user USER]
[--passwd PASSWD]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Endpoint name
--url URL - Server url
--tls TLS - Enable tls (default - no) ['yes', 'no']
--user USER - Service server user
--passwd PASSWD - Service server password
--descr DESCR - Endpoint description
Add notif mailings
notif mailing add
> notif mailing add [-h] --name NAME
--addresses ADDRESSES
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Mailings name
--addresses ADDRESSES - List of addresses for message
--descr DESCR - Mailings description
Delete notif mailings
notif mailing del
> notif mailing del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Mailings name
List notif mailings
notif mailing list
Show notif mailings
notif mailing show
> notif mailing show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Mailings name
Update notif mailings
notif mailing update
> notif mailing update [-h] --name NAME
--addresses ADDRESSES
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Mailings name
--addresses ADDRESSES - List of addresses for message
--descr DESCR - Mailings description
Add message to send
notif message add
> notif message add [-h] [--route ROUTE]
[--data DATA]
arguments:
-h, --help show this help message and exit
--route ROUTE - Notif route used to send
--data DATA - Message data
Delete message
notif message del
> notif message del [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Message UUID
List last messages
notif message list
> notif message list [-h] [--limit LIMIT]
arguments:
-h, --help show this help message and exit
--limit LIMIT - Limit count messages
Show message info by uuid
notif message show
> notif message show [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Message UUID
Add notif route
notif route add
> notif route add [-h] --name NAME
--endpoint ENDPOINT
--mailing MAILING
--sender SENDER
[--subject SUBJECT]
--template TEMPLATE
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Entry point of route
--endpoint ENDPOINT - Endpoint name
--mailing MAILING - Mailing name
--sender SENDER - Message sender
--subject SUBJECT - Message subject
--template TEMPLATE - Message template
--descr DESCR - Route description
Delete notif route
notif route del
> notif route del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Entry point of route
List notif routes
notif route list
Show notif route
notif route show
> notif route show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Entry point of route
Update notif route
notif route update
> notif route update [-h] --name NAME
--endpoint ENDPOINT
--mailing MAILING
--sender SENDER
[--subject SUBJECT]
--template TEMPLATE
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Entry point of route
--endpoint ENDPOINT - Endpoint name
--mailing MAILING - Mailing name
--sender SENDER - Message sender
--subject SUBJECT - Message subject
--template TEMPLATE - Message template
--descr DESCR - Route description
Add notif template
notif template add
> notif template add [-h] --name NAME
[--data DATA]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Template name
--data DATA - Template data (Jinja)
--descr DESCR - Mailings description
Delete notif template
notif template del
> notif template del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Template name
List notif templates
notif template list
Show notif template
notif template show
> notif template show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Template name
Update notif template
notif template update
> notif template update [-h] --name NAME
[--data DATA]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Template name
--data DATA - Template data (Jinja)
--descr DESCR - Mailings description
scheduler plugin
Mark cluster nodes as drain
scheduler drain add
> scheduler drain add [-h] --nodes NODES
arguments:
-h, --help show this help message and exit
--nodes NODES - list of nodes (or *)
Remove drain from nodes
scheduler drain del
> scheduler drain del [-h] --nodes NODES
arguments:
-h, --help show this help message and exit
--nodes NODES - list of nodes (or *)
Create new labels in cluster
scheduler labels add
> scheduler labels add [-h] --labels LABELS
--nodes NODES
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--labels LABELS - list of labels to add
--nodes NODES - list of nodes (or *) to assign labels to
--descr DESCR - label description
Assign labels to cluster nodes
scheduler labels assign
> scheduler labels assign [-h] --labels LABELS
--nodes NODES
arguments:
-h, --help show this help message and exit
--labels LABELS - list of labels to assign
--nodes NODES - list of nodes (or *) to assign labels to
Delete cluster labels
scheduler labels del
> scheduler labels del [-h] --labels LABELS
arguments:
-h, --help show this help message and exit
--labels LABELS - list of labels to delete
Delegate cluster labels to namespaces
scheduler labels delegate ns
> scheduler labels delegate ns [-h] --ns NS
--labels LABELS
arguments:
-h, --help show this help message and exit
--ns NS - list of namespaces (or *)
--labels LABELS - list of labels to delegate
Mark labels as ignored, either globally or in certain namespaces
scheduler labels ignore
> scheduler labels ignore [-h] --labels LABELS
[--ns NS]
arguments:
-h, --help show this help message and exit
--labels LABELS - list of labels to ignore
--ns NS - list of namespaces (or *) to ignore labels in (will ignore provided labels only in these namespaces)
List all cluster labels
scheduler labels list
> scheduler labels list [-h] [--nodes NODES]
[--filter FILTER]
arguments:
-h, --help show this help message and exit
--nodes NODES - nodes to list (or *)
--filter FILTER - labels filter: a - all, i - ignored, u - unignored
Lists nodes by labels
scheduler labels nodes list
> scheduler labels nodes list [-h] --labels LABELS
[--strict STRICT]
[--silent SILENT]
arguments:
-h, --help show this help message and exit
--labels LABELS - List of labels to search nodes by
--strict STRICT - list nodes that have full set of given labels y/n
--silent SILENT - silence non-existent labels errors y/n
List labels with namespaces they're delegated to
scheduler labels ns list
> scheduler labels ns list [-h] [--ns NS]
[--filter FILTER]
arguments:
-h, --help show this help message and exit
--ns NS - list of namespaces (or *)
--filter FILTER - labels filter: a - all, i - ignored, u - unignored
Show namespaces with their labels
scheduler labels ns show
> scheduler labels ns show [-h] [--ns NS]
[--filter FILTER]
arguments:
-h, --help show this help message and exit
--ns NS - List of namespaces (or *)
--filter FILTER - labels filter: a - all, i - ignored, u - unignored
Mark labels as unignored
scheduler labels unignore
> scheduler labels unignore [-h] --labels LABELS
[--ns NS]
arguments:
-h, --help show this help message and exit
--labels LABELS - list of labels to unignore
--ns NS - list of namespaces (or *) to unignore labels in
Add namespace labels to vclusters
scheduler labels vcluster add
> scheduler labels vcluster add [-h] --vcluster VCLUSTER
--labels LABELS
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - list of vclusters (or *)
--labels LABELS - list of labels to add
Delete labels from vcluster
scheduler labels vcluster del
> scheduler labels vcluster del [-h] --vcluster VCLUSTER
--labels LABELS
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - list of vclusters (or *)
--labels LABELS - list of labels to del
List labels with current namespace vclusters
scheduler labels vcluster list
> scheduler labels vcluster list [-h] [--vcluster VCLUSTER]
[--filter FILTER]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - list of vclusters (or *)
--filter FILTER - labels filter: a - all, i - ignored, u - unignored
Show current namespace vclusters with their labels
scheduler labels vcluster show
> scheduler labels vcluster show [-h] --vcluster VCLUSTER
[--filter FILTER]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - List of vclusters (or *)
--filter FILTER - labels filter: a - all, i - ignored, u - unignored
Return info about ifaces in selected vcluster or request
scheduler report iface
> scheduler report iface [-h] [--request REQUEST]
[--vcluster VCLUSTER]
arguments:
-h, --help show this help message and exit
--request REQUEST - request
--vcluster VCLUSTER - vcluster
Add Scheduler request
scheduler request add
> scheduler request add [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
[--descr DESCR]
[--labels LABELS]
--data DATA
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Resource name
--descr DESCR - Vcluster Description
--labels LABELS - {{ no such element: dict object['desc'] }}
--data DATA - Specs definition
Clear Scheduler request
scheduler request clear
> scheduler request clear [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Resource name
Del Scheduler request
scheduler request del
> scheduler request del [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
[--backup BACKUP]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Resource name
--backup BACKUP - Create snapshot(delete_after=1d) VMs before delete (if enough space). Default - yes ['yes', 'no']
List Scheduler requests
scheduler request list
> scheduler request list [-h] --vcluster VCLUSTER
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
Migrate Scheduler request
scheduler request migrate
> scheduler request migrate [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
--node NODE
--mode MODE
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Resource name
--node NODE - Destination host
--mode MODE - Migration mode ['live', 'offline']
Show Scheduler request
scheduler request show
> scheduler request show [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
[--show_uuid SHOW_UUID]
[--metrics METRICS]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Resource name
--show_uuid SHOW_UUID - show object uuid
--metrics METRICS - Get metrics VM ['yes', 'no']
Add snapshot request
scheduler request snapshot add
> scheduler request snapshot add [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
--snapshot_name SNAPSHOT_NAME
[--vms VMS]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Resource name
--snapshot_name SNAPSHOT_NAME - Snapshot name
--vms VMS - List of VMs
--descr DESCR - Snapshot description
Snapshot clear
scheduler request snapshot clear
> scheduler request snapshot clear [-h] --name NAME
[--kind KIND]
--vcluster VCLUSTER
--uuid UUID
arguments:
-h, --help show this help message and exit
--name NAME - Resource name
--kind KIND - Requets type (Default - vm) ['vm']
--vcluster VCLUSTER - Vcluster name
--uuid UUID - Snapshot UUID
Snapshot del
scheduler request snapshot del
> scheduler request snapshot del [-h] --name NAME
[--kind KIND]
--vcluster VCLUSTER
--uuid UUID
arguments:
-h, --help show this help message and exit
--name NAME - Resource name
--kind KIND - Requets type (Default - vm) ['vm']
--vcluster VCLUSTER - Vcluster name
--uuid UUID - Snapshot UUID
Snapshots list
scheduler request snapshot list
> scheduler request snapshot list [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Request name
Scheduler request revert to snapshot
scheduler request snapshot revert
> scheduler request snapshot revert [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
--uuid UUID
[--vms VMS]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Resource name
--uuid UUID - Snapshot UUID
--vms VMS - List of VMs
Snapshot show
scheduler request snapshot show
> scheduler request snapshot show [-h] --name NAME
[--kind KIND]
--vcluster VCLUSTER
--uuid UUID
arguments:
-h, --help show this help message and exit
--name NAME - Resource name
--kind KIND - Requets type (Default - vm) ['vm']
--vcluster VCLUSTER - Vcluster name
--uuid UUID - Snapshot UUID
Change Scheduler request state
scheduler request state
> scheduler request state [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
[--vms VMS]
--state STATE
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Resource name
--vms VMS - List of VMs
--state STATE - Scheduler request state ['START', 'STOP', 'REBOOT', 'SUSPEND', 'RESUME']
Scheduler request status
scheduler request status
> scheduler request status [-h] --vcluster VCLUSTER
[--kind KIND]
[--name NAME]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Request name
Update Scheduler request without re-creation vm
scheduler request update
> scheduler request update [-h] --vcluster VCLUSTER
[--kind KIND]
--name NAME
[--descr DESCR]
[--labels LABELS]
--data DATA
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--kind KIND - Requets type (Default - vm) ['vm']
--name NAME - Resource name
--descr DESCR - Vcluster Description
--labels LABELS - {{ no such element: dict object['desc'] }}
--data DATA - Specs definition
Requests VNC connection credentials to specified VM
scheduler request vnc
> scheduler request vnc [-h] --vcluster VCLUSTER
--name NAME
--vm_name VM_NAME
[--timeout TIMEOUT]
[--idle_timeout IDLE_TIMEOUT]
[--hb HB]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--name NAME - Resource name
--vm_name VM_NAME - VM name
--timeout TIMEOUT - wait sec to kill VNC proxy before connect
--idle_timeout IDLE_TIMEOUT - wait sec before killing VNC proxy after disconnect
--hb HB - VNC proxy heartbeat sec
Add User Scheduler params
scheduler user param add
> scheduler user param add [-h] --vcluster VCLUSTER
--login LOGIN
[--rf RF]
[--isolation_strategy ISOLATION_STRATEGY]
[--drain_strategy DRAIN_STRATEGY]
[--vcpu VCPU]
[--vram VRAM]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--login LOGIN - User Login
--rf RF - Replication factor
--isolation_strategy ISOLATION_STRATEGY - Isolation node strategy (Default - NOTHING) ['STOP', 'NOTHING', 'RECREATE']
--drain_strategy DRAIN_STRATEGY - Drain node strategy (Default - NOTHING) ['STOP', 'NOTHING', 'MIGRATE']
--vcpu VCPU - User vCPU limit
--vram VRAM - User RAM limit
Show User Scheduler params for admin
scheduler user param admin
> scheduler user param admin [-h] --vcluster VCLUSTER
--login LOGIN
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--login LOGIN - User Login
Delete User Scheduler params
scheduler user param del
> scheduler user param del [-h] --vcluster VCLUSTER
--login LOGIN
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--login LOGIN - User Login
List User Scheduler params
scheduler user param list
> scheduler user param list [-h] --vcluster VCLUSTER
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
Show User Scheduler params
scheduler user param show
> scheduler user param show [-h] --vcluster VCLUSTER
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
Update User Scheduler params
scheduler user param update
> scheduler user param update [-h] --vcluster VCLUSTER
--login LOGIN
[--rf RF]
[--isolation_strategy ISOLATION_STRATEGY]
[--drain_strategy DRAIN_STRATEGY]
[--vcpu VCPU]
[--vram VRAM]
arguments:
-h, --help show this help message and exit
--vcluster VCLUSTER - Vcluster name
--login LOGIN - User Login
--rf RF - Replication factor
--isolation_strategy ISOLATION_STRATEGY - Isolation node strategy (Default - NOTHING) ['STOP', 'NOTHING', 'RECREATE']
--drain_strategy DRAIN_STRATEGY - Drain node strategy (Default - NOTHING) ['STOP', 'NOTHING', 'MIGRATE']
--vcpu VCPU - User vCPU limit
--vram VRAM - User RAM limit
Add Vcluster
scheduler vcluster add
> scheduler vcluster add [-h] --name NAME
[--uuids UUIDS]
[--descr DESCR]
--labels LABELS
[--rf RF]
[--isolation_strategy ISOLATION_STRATEGY]
[--drain_strategy DRAIN_STRATEGY]
[--ulimits ULIMITS]
[--vcpu VCPU]
[--vram VRAM]
[--vcpu_scaling VCPU_SCALING]
[--vram_scaling VRAM_SCALING]
[--path_to PATH_TO]
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
--uuids UUIDS - List of UUID nodes
--descr DESCR - Vcluster Description
--labels LABELS - {{ no such element: dict object['desc'] }}
--rf RF - Replication factor
--isolation_strategy ISOLATION_STRATEGY - Isolation node strategy (Default - RECREATE) ['STOP', 'NOTHING', 'RECREATE']
--drain_strategy DRAIN_STRATEGY - Drain node strategy (Default - MIGRATE) ['STOP', 'NOTHING', 'MIGRATE']
--ulimits ULIMITS - Enable user limits (Default - yes) ['yes', 'no']
--vcpu VCPU - Vcluster vCPU limit
--vram VRAM - Vcluster RAM limit
--vcpu_scaling VCPU_SCALING - should system reserve 2x vcpu per domain for potential scaling in future
--vram_scaling VRAM_SCALING - should system reserve 2x vram per domain for potential scaling in future
--path_to PATH_TO - Placing an object in the directory structure
Clear Vcluster definition
scheduler vcluster clear
> scheduler vcluster clear [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
Del Vcluster
scheduler vcluster del
> scheduler vcluster del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
List Vclusters
scheduler vcluster list
Add Vcluster nodes
scheduler vcluster nodes add
> scheduler vcluster nodes add [-h] --name NAME
--uuids UUIDS
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
--uuids UUIDS - List of UUID nodes
Del Vcluster nodes
scheduler vcluster nodes del
> scheduler vcluster nodes del [-h] --name NAME
--uuids UUIDS
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
--uuids UUIDS - List of UUID nodes
List Vcluster nodes
scheduler vcluster nodes list
> scheduler vcluster nodes list [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
View available VRAM and VCPU resources for Namespace
scheduler vcluster resource show
Show Vcluster
scheduler vcluster show
> scheduler vcluster show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
Add Vcluster nodes taints
scheduler vcluster taints add
> scheduler vcluster taints add [-h] --name NAME
--uuids UUIDS
--taints TAINTS
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
--uuids UUIDS - List of UUID nodes
--taints TAINTS - {{ no such element: dict object['desc'] }}
Del Vcluster nodes taints
scheduler vcluster taints del
> scheduler vcluster taints del [-h] --name NAME
--uuids UUIDS
--taints TAINTS
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
--uuids UUIDS - List of UUID nodes
--taints TAINTS - {{ no such element: dict object['desc'] }}
Update Vcluster
scheduler vcluster update
> scheduler vcluster update [-h] --name NAME
[--descr DESCR]
[--rf RF]
[--vcpu VCPU]
[--vram VRAM]
[--isolation_strategy ISOLATION_STRATEGY]
[--drain_strategy DRAIN_STRATEGY]
[--ulimits ULIMITS]
arguments:
-h, --help show this help message and exit
--name NAME - Vcluster name
--descr DESCR - Vcluster Description
--rf RF - Replication factor
--vcpu VCPU - Vcluster vCPU limit
--vram VRAM - Vcluster RAM limit
--isolation_strategy ISOLATION_STRATEGY - Isolation node strategy (Default - RECREATE) ['STOP', 'NOTHING', 'RECREATE']
--drain_strategy DRAIN_STRATEGY - Drain node strategy (Default - MIGRATE) ['STOP', 'NOTHING', 'MIGRATE']
--ulimits ULIMITS - Enable user limits (Default - yes) ['yes', 'no']
services plugin
List all systemd services from SDC_SERVICE_LIST
services available systemd list
Show systemd service from available list
services available systemd show
> services available systemd show [-h] --unit UNIT
--uuid UUID
arguments:
-h, --help show this help message and exit
--unit UNIT - Systemd service name
--uuid UUID - Node UUID
Add systemd service
services global systemd add
> services global systemd add [-h] --name NAME
--code CODE
--state STATE
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Systemd service name
--code CODE - Run strategy (default - VIP) ['VIP', 'ALL']
--state STATE - Service state (default - start) ['start', 'stop']
--descr DESCR - Service description
Delete systemd service
services global systemd del
> services global systemd del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Systemd service name
List systemd services
services global systemd list
Show systemd service
services global systemd show
> services global systemd show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Systemd service name
Update systemd service
services global systemd update
> services global systemd update [-h] --name NAME
--code CODE
--state STATE
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Systemd service name
--code CODE - Run strategy (default - VIP) ['VIP', 'ALL']
--state STATE - Service state (default - start) ['start', 'stop']
--descr DESCR - Service description
signer plugin
Add sign entity
signer entity add
> signer entity add [-h] --name NAME
--mod MOD
--classz CLASSZ
[--include INCLUDE]
[--exclude EXCLUDE]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Entity name
--mod MOD - Plugin name
--classz CLASSZ - Module name
--include INCLUDE - List of IDs to include
--exclude EXCLUDE - List of IDs to exclude
--descr DESCR - Description
Delete sign entity
signer entity del
> signer entity del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Entity name
List sign entities
signer entity list
Show sign entity
signer entity show
> signer entity show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - Entity name
Add sign file
signer file add
> signer file add [-h] --node NODE
--filepath FILEPATH
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--node NODE - Node UUID
--filepath FILEPATH - Path to file
--descr DESCR - Description
Delete sign file
signer file del
> signer file del [-h] --node NODE
[--filepath FILEPATH]
arguments:
-h, --help show this help message and exit
--node NODE - Node UUID
--filepath FILEPATH - Path to file
List sign files
signer file list
Show sign file
signer file show
> signer file show [-h] --node NODE
--filepath FILEPATH
arguments:
-h, --help show this help message and exit
--node NODE - Node UUID
--filepath FILEPATH - Path to file
Add key
signer key add
> signer key add [-h] [--algorithm ALGORITHM]
[--expire EXPIRE]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--algorithm ALGORITHM - Key algorithm (default - rsa2048) ['rsa2048', 'rsa3072', 'rsa4096']
--expire EXPIRE - Expire Date/ period (default - 365d)
--descr DESCR - Key description
Delete key
signer key del
> signer key del [-h] [--keyid KEYID]
arguments:
-h, --help show this help message and exit
--keyid KEYID - Key ID
List keys
signer key list
Show key
signer key show
> signer key show [-h] --keyid KEYID
arguments:
-h, --help show this help message and exit
--keyid KEYID - Key ID
Add Signer params
signer param add
> signer param add [-h] [--sign_cert SIGN_CERT]
[--sign_enable SIGN_ENABLE]
[--validation_interval VALIDATION_INTERVAL]
[--validation_action VALIDATION_ACTION]
[--sign_models SIGN_MODELS]
arguments:
-h, --help show this help message and exit
--sign_cert SIGN_CERT - Cert fingerprint to sign objetcs in namespace
--sign_enable SIGN_ENABLE - Enable signing (default - no) ['yes', 'no']
--validation_interval VALIDATION_INTERVAL - Inverval for validation
--validation_action VALIDATION_ACTION - Action for invalid objects (default - ERROR) ['ERROR', 'WARN']
--sign_models SIGN_MODELS - List of models for signing
Delete Signer params
signer param del
Show Signer params
signer param show
Update Signer params
signer param update
> signer param update [-h] [--sign_cert SIGN_CERT]
[--sign_enable SIGN_ENABLE]
[--validation_interval VALIDATION_INTERVAL]
[--validation_action VALIDATION_ACTION]
[--sign_models SIGN_MODELS]
arguments:
-h, --help show this help message and exit
--sign_cert SIGN_CERT - Cert fingerprint to sign objetcs in namespace
--sign_enable SIGN_ENABLE - Enable signing (default - no) ['yes', 'no']
--validation_interval VALIDATION_INTERVAL - Inverval for validation
--validation_action VALIDATION_ACTION - Action for invalid objects (default - ERROR) ['ERROR', 'WARN']
--sign_models SIGN_MODELS - List of models for signing
sign_entity_del
signer sign entity del
> signer sign entity del [-h] --pk PK
arguments:
-h, --help show this help message and exit
--pk PK - pk
sign_entity_disable
signer sign entity disable
> signer sign entity disable [-h] --pk PK
arguments:
-h, --help show this help message and exit
--pk PK - pk
sign_entity_enable
signer sign entity enable
> signer sign entity enable [-h] --pk PK
[--force_sign FORCE_SIGN]
arguments:
-h, --help show this help message and exit
--pk PK - pk
--force_sign FORCE_SIGN - force_sign
sign_entity_list
signer sign entity list
> signer sign entity list [-h] --model MODEL
arguments:
-h, --help show this help message and exit
--model MODEL - model
sign_model_add
signer sign model add
> signer sign model add [-h] --models MODELS
[--force_sign FORCE_SIGN]
arguments:
-h, --help show this help message and exit
--models MODELS - models
--force_sign FORCE_SIGN - force_sign
sign_model_del
signer sign model del
> signer sign model del [-h] --models MODELS
arguments:
-h, --help show this help message and exit
--models MODELS - models
sign_model_list
signer sign model list
storage plugin
Create backup task
storage libvirt backup add
> storage libvirt backup add [-h] --vm_name VM_NAME
[--sc_node SC_NODE]
[--disks DISKS]
[--timeout TIMEOUT]
arguments:
-h, --help show this help message and exit
--vm_name VM_NAME - VM name
--sc_node SC_NODE - Node, where vm located
--disks DISKS - vm disks to backup
--timeout TIMEOUT - timeout for backup
Del backup task
storage libvirt backup del
> storage libvirt backup del [-h] [--name NAME]
[--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--name NAME - Snapshot name
--sc_node SC_NODE - Node UUID location (default - current node)
List Libvirt Backups
storage libvirt backup list
> storage libvirt backup list [-h] [--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--sc_node SC_NODE - Node UUID location (default - current node)
View full VM description from backup
storage libvirt backup lookup
> storage libvirt backup lookup [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - VM name
Show Backup
storage libvirt backup show
> storage libvirt backup show [-h] [--name NAME]
[--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--name NAME - Snapshot name
--sc_node SC_NODE - Node UUID location (default - current node)
Upload image to libvirt storage
storage libvirt image upload
> storage libvirt image upload [-h] --name NAME
--pool POOL
--path PATH
[--descr DESCR]
[--sc_node SC_NODE]
[--path_to PATH_TO]
arguments:
-h, --help show this help message and exit
--name NAME - Volume name
--pool POOL - Pool name
--path PATH - Image path
--descr DESCR - Volume description
--sc_node SC_NODE - Node UUID location (default - current node)
--path_to PATH_TO - Placing an object in the directory structure
Add libvirt storage pool
storage libvirt pool add
> storage libvirt pool add [-h] --name NAME
[--descr DESCR]
[--sc_node SC_NODE]
[--labels LABELS]
arguments:
-h, --help show this help message and exit
--name NAME - name
--descr DESCR - Pool description
--sc_node SC_NODE - Node UUID location (default - current node)
--labels LABELS - Pool Labels
Clear libvirt storage pool
storage libvirt pool clear
> storage libvirt pool clear [-h] [--uuid UUID]
--name NAME
[--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--uuid UUID - UUID
--name NAME - name
--sc_node SC_NODE - Node UUID location (default - current node)
Del libvirt storage pool
storage libvirt pool del
> storage libvirt pool del [-h] [--uuid UUID]
--name NAME
[--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--uuid UUID - UUID
--name NAME - name
--sc_node SC_NODE - Node UUID location (default - current node)
List libvirt storage pools
storage libvirt pool list
> storage libvirt pool list [-h] [--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--sc_node SC_NODE - Node UUID location (default - current node)
Show libvirt storage pool
storage libvirt pool show
> storage libvirt pool show [-h] [--uuid UUID]
--name NAME
[--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--uuid UUID - UUID
--name NAME - name
--sc_node SC_NODE - Node UUID location (default - current node)
Add Snapshot
storage libvirt snapshot add
> storage libvirt snapshot add [-h] [--uuid UUID]
[--name NAME]
--vm_name VM_NAME
[--disks DISKS]
[--descr DESCR]
[--labels LABELS]
--vcluster_name VCLUSTER_NAME
arguments:
-h, --help show this help message and exit
--uuid UUID - Snapshot UUID
--name NAME - Snapshot name
--vm_name VM_NAME - VM name
--disks DISKS - List of disks images
--descr DESCR - Snapshot description
--labels LABELS - {{ no such element: dict object['desc'] }}
--vcluster_name VCLUSTER_NAME - Vcluster name
Clear Snapshot definition
storage libvirt snapshot clear
> storage libvirt snapshot clear [-h] [--name NAME]
--vm_name VM_NAME
--vcluster_name VCLUSTER_NAME
arguments:
-h, --help show this help message and exit
--name NAME - Snapshot name
--vm_name VM_NAME - VM name
--vcluster_name VCLUSTER_NAME - Vcluster name
Del Snapshot
storage libvirt snapshot del
> storage libvirt snapshot del [-h] [--name NAME]
--vm_name VM_NAME
--vcluster_name VCLUSTER_NAME
arguments:
-h, --help show this help message and exit
--name NAME - Snapshot name
--vm_name VM_NAME - VM name
--vcluster_name VCLUSTER_NAME - Vcluster name
List Snapshots
storage libvirt snapshot list
> storage libvirt snapshot list [-h] [--vm_name VM_NAME]
[--request_name REQUEST_NAME]
--vcluster_name VCLUSTER_NAME
arguments:
-h, --help show this help message and exit
--vm_name VM_NAME - Vm name
--request_name REQUEST_NAME - Request name
--vcluster_name VCLUSTER_NAME - Vcluster name
Show Snapshot
storage libvirt snapshot show
> storage libvirt snapshot show [-h] [--name NAME]
--vm_name VM_NAME
--vcluster_name VCLUSTER_NAME
arguments:
-h, --help show this help message and exit
--name NAME - Snapshot name
--vm_name VM_NAME - VM name
--vcluster_name VCLUSTER_NAME - Vcluster name
Add libvirt storage volume
storage libvirt volume add
> storage libvirt volume add [-h] --name NAME
--pool POOL
--capacity CAPACITY
[--frmt FRMT]
[--source SOURCE]
[--descr DESCR]
[--sc_node SC_NODE]
[--labels LABELS]
[--path_to PATH_TO]
arguments:
-h, --help show this help message and exit
--name NAME - Volume name
--pool POOL - Pool name
--capacity CAPACITY - Volume size
--frmt FRMT - Volume format (default - qcow2)
--source SOURCE - Source volume name (clone)
--descr DESCR - Volume description
--sc_node SC_NODE - Node UUID location (default - current node)
--labels LABELS - Volume Labels
--path_to PATH_TO - Placing an object in the directory structure
Clear libvirt storage volume
storage libvirt volume clear
> storage libvirt volume clear [-h] [--uuid UUID]
--name NAME
--pool POOL
[--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--uuid UUID - UUID
--name NAME - Volume name
--pool POOL - Pool name
--sc_node SC_NODE - Node UUID location (default - current node)
Del libvirt storage volume
storage libvirt volume del
> storage libvirt volume del [-h] [--uuid UUID]
--name NAME
--pool POOL
[--sc_node SC_NODE]
[--del_type DEL_TYPE]
[--del_iter DEL_ITER]
arguments:
-h, --help show this help message and exit
--uuid UUID - UUID
--name NAME - Volume name
--pool POOL - Pool name
--sc_node SC_NODE - Node UUID location (default - current node)
--del_type DEL_TYPE - {{ no such element: dict object['desc'] }}
--del_iter DEL_ITER - {{ no such element: dict object['desc'] }}
List libvirt storage volumes
storage libvirt volume list
> storage libvirt volume list [-h] --pool POOL
[--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--pool POOL - Pool name
--sc_node SC_NODE - Node UUID location (default - current node)
Show libvirt storage volume
storage libvirt volume show
> storage libvirt volume show [-h] [--uuid UUID]
--name NAME
--pool POOL
[--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--uuid UUID - UUID
--name NAME - Volume name
--pool POOL - Pool name
--sc_node SC_NODE - Node UUID location (default - current node)
Add more capacity to libvirt storage volume
storage libvirt volume update
> storage libvirt volume update [-h] --name NAME
--pool POOL
--capacity CAPACITY
[--sc_node SC_NODE]
arguments:
-h, --help show this help message and exit
--name NAME - Volume name
--pool POOL - Pool name
--capacity CAPACITY - Volume size
--sc_node SC_NODE - Node UUID location (default - current node)
Add new mount to DB
storage nfs mount add
> storage nfs mount add [-h] --name NAME
--nfs_server NFS_SERVER
--shared_folder_path SHARED_FOLDER_PATH
[--mount_point MOUNT_POINT]
[--params PARAMS]
--nodes NODES
--ns NS
[--autocheck AUTOCHECK]
[--check_timeout CHECK_TIMEOUT]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--name NAME - Name of NFS mount
--nfs_server NFS_SERVER - IP of NFS server
--shared_folder_path SHARED_FOLDER_PATH - Path to shared folder
--mount_point MOUNT_POINT - Folder where shared folder should be mounted
--params PARAMS - {{ no such element: dict object['desc'] }}
--nodes NODES - Nodes to mount
--ns NS - Namespaces to access this mount
--autocheck AUTOCHECK - Enable autocheck for this mount ['yes', 'no']
--check_timeout CHECK_TIMEOUT - Time between checks in seconds (if autocheck is enabled)
--descr DESCR - Mount description
Mount the NFS file share
storage nfs mount connect
> storage nfs mount connect [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Mount UUID
Delete mount from DB
storage nfs mount del
> storage nfs mount del [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Mount UUID
Unmount the NFS file share
storage nfs mount disconnect
> storage nfs mount disconnect [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Mount UUID
List all mounts
storage nfs mount list
Add new nodes and mount them immediately (perform if the rest of nodes is already mounted)
storage nfs mount nodes add
> storage nfs mount nodes add [-h] --nodes NODES
--uuid UUID
arguments:
-h, --help show this help message and exit
--nodes NODES - Nodes
--uuid UUID - Mount UUID
Delete some of the nodes from a mount (perform only if unmounted)
storage nfs mount nodes del
> storage nfs mount nodes del [-h] --nodes NODES
--uuid UUID
arguments:
-h, --help show this help message and exit
--nodes NODES - Nodes
--uuid UUID - Mount UUID
Add new namespaces to a mount (perform only if mounted)
storage nfs mount ns add
> storage nfs mount ns add [-h] --uuid UUID
--ns NS
arguments:
-h, --help show this help message and exit
--uuid UUID - Mount UUID
--ns NS - Namespaces to add
Delete some of the namespaces from a mount (perform only if unmounted)
storage nfs mount ns del
> storage nfs mount ns del [-h] --uuid UUID
--ns NS
arguments:
-h, --help show this help message and exit
--uuid UUID - Mount UUID
--ns NS - Namespaces to delete
Show mount info
storage nfs mount show
> storage nfs mount show [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Mount UUID
Check if connection is up for this mount (either on one node or all of them)
storage nfs mount test
> storage nfs mount test [-h] --uuid UUID
[--nodes NODES]
arguments:
-h, --help show this help message and exit
--uuid UUID - Mount UUID
--nodes NODES - Nodes to test
Update mount settings (perform only if unmounted)
storage nfs mount update
> storage nfs mount update [-h] --uuid UUID
[--name NAME]
[--nfs_server NFS_SERVER]
[--shared_folder_path SHARED_FOLDER_PATH]
[--mount_point MOUNT_POINT]
[--params PARAMS]
[--autocheck AUTOCHECK]
[--check_timeout CHECK_TIMEOUT]
[--descr DESCR]
arguments:
-h, --help show this help message and exit
--uuid UUID - Mount UUID
--name NAME - Name of NFS mount
--nfs_server NFS_SERVER - IP of NFS server
--shared_folder_path SHARED_FOLDER_PATH - Path to shared folder
--mount_point MOUNT_POINT - Folder where shared folder should be mounted
--params PARAMS - {{ no such element: dict object['desc'] }}
--autocheck AUTOCHECK - Enable autocheck for this mount ['yes', 'no']
--check_timeout CHECK_TIMEOUT - Time between checks in seconds (if autocheck is enabled)
--descr DESCR - Mount description
Create volume in nfs storage
storage nfs volume add
> storage nfs volume add [-h] --name NAME
--mount_uuid MOUNT_UUID
[--size SIZE]
--type TYPE
--persistent PERSISTENT
[--base_on BASE_ON]
[--descr DESCR]
[--path_to PATH_TO]
arguments:
-h, --help show this help message and exit
--name NAME - The name of the volume
--mount_uuid MOUNT_UUID - NFS mount name
--size SIZE - The volume size
--type TYPE - Volume type ['cdrom', 'system', 'datablock']
--persistent PERSISTENT - Volume is persistent ['yes', 'no']
--base_on BASE_ON - The uuid of an already existing volume that the new volume is to be a copy of
--descr DESCR - Volume description
--path_to PATH_TO - Placing an object in the directory structure
Clear NFS volume
storage nfs volume clear
> storage nfs volume clear [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
Delete NFS volume
storage nfs volume del
> storage nfs volume del [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
Import image to NFS storage
storage nfs volume import
> storage nfs volume import [-h] --name NAME
--mount_uuid MOUNT_UUID
--type TYPE
--persistent PERSISTENT
[--descr DESCR]
--path PATH
[--path_to PATH_TO]
arguments:
-h, --help show this help message and exit
--name NAME - The name of the volume
--mount_uuid MOUNT_UUID - NFS mount name
--type TYPE - Volume type ['cdrom', 'system', 'datablock']
--persistent PERSISTENT - Volume is persistent ['yes', 'no']
--descr DESCR - Volume description
--path PATH - Path to image (path folder or URL)
--path_to PATH_TO - Placing an object in the directory structure
List NFS volumes
storage nfs volume list
> storage nfs volume list [-h] [--mount_uuid MOUNT_UUID]
[--all ALL]
arguments:
-h, --help show this help message and exit
--mount_uuid MOUNT_UUID - {{ no such element: dict object['desc'] }}
--all ALL - List all volumes ['yes', 'no']
Show NFS volume
storage nfs volume show
> storage nfs volume show [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
List SP volumes attached
storage sp attach list
Show attach SP volume
storage sp attach show
> storage sp attach show [-h] --volume_uuid VOLUME_UUID
[--sc_uuid SC_UUID]
arguments:
-h, --help show this help message and exit
--volume_uuid VOLUME_UUID - Volume UUID
--sc_uuid SC_UUID - UUID node to attach
Attach SP volume
storage sp attach volume
> storage sp attach volume [-h] --volume_uuid VOLUME_UUID
--mode MODE
--sc_uuid SC_UUID
arguments:
-h, --help show this help message and exit
--volume_uuid VOLUME_UUID - Volume uuid
--mode MODE - The mode of the volume ['rw', 'ro']
--sc_uuid SC_UUID - UUID node to attach
Detach SP volume
storage sp detach volume
> storage sp detach volume [-h] --volume_uuid VOLUME_UUID
--sc_uuid SC_UUID
[--force FORCE]
arguments:
-h, --help show this help message and exit
--volume_uuid VOLUME_UUID - Volume uuid
--sc_uuid SC_UUID - UUID node to attach
--force FORCE - The clients on which to attach the volume as read only
The name of a placement group which describes the disks to be used
storage sp placementGroup list
Add amount reserved inside placementGroup
storage sp placementGroup resources reserved add
> storage sp placementGroup resources reserved add [-h] --place PLACE
[--reserved RESERVED]
arguments:
-h, --help show this help message and exit
--place PLACE - PlacementGroup name
--reserved RESERVED - Value subtituted from placementGroup limit
Del reserved inside placementGroup
storage sp placementGroup resources reserved del
> storage sp placementGroup resources reserved del [-h] --place PLACE
arguments:
-h, --help show this help message and exit
--place PLACE - PlacementGroup name
List reserved inside placementGroup
storage sp placementGroup resources reserved list
> storage sp placementGroup resources reserved list [-h]
arguments:
-h, --help show this help message and exit
Show reserved inside placementGroup
storage sp placementGroup resources reserved show
> storage sp placementGroup resources reserved show [-h] --place PLACE
arguments:
-h, --help show this help message and exit
--place PLACE - PlacementGroup name
Update amount reserved inside placementGroup
storage sp placementGroup resources reserved update
> storage sp placementGroup resources reserved update [-h] --place PLACE
[--reserved RESERVED]
arguments:
-h, --help show this help message and exit
--place PLACE - PlacementGroup name
--reserved RESERVED - Value subtituted from placementGroup limit
Resource show for placement group
storage sp placementGroup resources show
> storage sp placementGroup resources show [-h] --place PLACE
arguments:
-h, --help show this help message and exit
--place PLACE - {{ no such element: dict object['desc'] }}
Add SP volume snapshot
storage sp snapshot add
> storage sp snapshot add [-h] --name NAME
[--descr DESCR]
--volume_uuid VOLUME_UUID
arguments:
-h, --help show this help message and exit
--name NAME - The name of the volume
--descr DESCR - Volume description
--volume_uuid VOLUME_UUID - Volume UUID
Clear SP volume snapshot
storage sp snapshot clear
> storage sp snapshot clear [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
Del SP volume snapshot
storage sp snapshot del
> storage sp snapshot del [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
List SP volume snapshot
storage sp snapshot list
> storage sp snapshot list [-h] [--volume_uuid VOLUME_UUID]
arguments:
-h, --help show this help message and exit
--volume_uuid VOLUME_UUID - {{ no such element: dict object['desc'] }}
Show SP volume snapshot
storage sp snapshot show
> storage sp snapshot show [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
Update SP volume snapshot
storage sp snapshot update
> storage sp snapshot update [-h] --uuid UUID
[--name NAME]
[--descr DESCR]
[--delete_after DELETE_AFTER]
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
--name NAME - Snapshot name
--descr DESCR - Description of snapshot
--delete_after DELETE_AFTER - Delete snapshots after X seconds (If not 0 set targetDeleteDate relative to the current time)
Add SP volume template
storage sp template add
> storage sp template add [-h] [--bw BW]
[--iops IOPS]
[--descr DESCR]
--name NAME
[--parent PARENT]
--place PLACE
--replication REPLICATION
[--reuse_server REUSE_SERVER]
--capacity CAPACITY
--ns NS
arguments:
-h, --help show this help message and exit
--bw BW - Bandwidth limit in KB
--iops IOPS - Iops limit
--descr DESCR - Volume template description
--name NAME - The name of the template
--parent PARENT - The name of the snapshot on which volumes will be based.The value must be of one of the following types: SnapshotName
--place PLACE - The name of a placement group which describes the disks to be used for all but the last replica
--replication REPLICATION - A default number of copies to be kept by StoragePool.The value must be of one of the following types: Replication
--reuse_server REUSE_SERVER - Allow placement of replicas on same server
--capacity CAPACITY - capacity
--ns NS - Virtual DC
Clear SP volumes templates
storage sp template clear
> storage sp template clear [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - The name of the template
Delete SP volumes template
storage sp template del
> storage sp template del [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - The name of the template
List SP volumes template limit
storage sp template limit list
View SP volumes template limit
storage sp template limit show
> storage sp template limit show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - The name of the template
List SP volumes templates
storage sp template list
Show SP volumes template
storage sp template show
> storage sp template show [-h] --name NAME
arguments:
-h, --help show this help message and exit
--name NAME - The name of the template
Update SP volume template
storage sp template update
> storage sp template update [-h] [--bw BW]
[--iops IOPS]
[--descr DESCR]
--name NAME
[--parent PARENT]
[--replication REPLICATION]
[--reuse_server REUSE_SERVER]
[--capacity CAPACITY]
[--ns NS]
arguments:
-h, --help show this help message and exit
--bw BW - Bandwidth limit in KB
--iops IOPS - Iops limit
--descr DESCR - Volume template description
--name NAME - The name of the template
--parent PARENT - The name of the snapshot on which volumes will be based.The value must be of one of the following types: SnapshotName
--replication REPLICATION - Replication copies count
--reuse_server REUSE_SERVER - Allow placement of replicas on same server
--capacity CAPACITY - Template size limit
--ns NS - Namespace owner
Add SP volume
storage sp volume add
> storage sp volume add [-h] [--bw BW]
[--iops IOPS]
[--descr DESCR]
--name NAME
[--parent PARENT]
[--reuse_server REUSE_SERVER]
--size SIZE
--template TEMPLATE
[--base_on BASE_ON]
--type TYPE
--persistent PERSISTENT
[--path_to PATH_TO]
arguments:
-h, --help show this help message and exit
--bw BW - Bandwidth limit in KB
--iops IOPS - Iops limit
--descr DESCR - Volume description
--name NAME - The name of the volume
--parent PARENT - The name of the snapshot on which volumes will be based.The value must be of one of the following types: SnapshotName
--reuse_server REUSE_SERVER - Allow placement of replicas on same server
--size SIZE - The volume size in bytes.
--template TEMPLATE - The template that the volume settings are inherited from
--base_on BASE_ON - The name of an already existing volume that the new volume is to be a copy of
--type TYPE - Volume type ['cdrom', 'system', 'datablock']
--persistent PERSISTENT - Volume is persistent ['yes', 'no']
--path_to PATH_TO - Placing an object in the directory structure
Clear SP volume
storage sp volume clear
> storage sp volume clear [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
Delete SP volume
storage sp volume del
> storage sp volume del [-h] --uuid UUID
[--force FORCE]
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
--force FORCE - Forced removal of snapshots. Default - no ['yes', 'no']
Export SP volume from storage to local storage
storage sp volume export
> storage sp volume export [-h] --uuid UUID
--export_name EXPORT_NAME
[--export_format EXPORT_FORMAT]
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
--export_name EXPORT_NAME - Export name
--export_format EXPORT_FORMAT - Export format ['qcow2', 'iso']
Convert the SP volume to a snapshot (volume to be removed)
storage sp volume freeze
> storage sp volume freeze [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
Create SP volume from volume or snapshot
storage sp volume fromparent
> storage sp volume fromparent [-h] --name NAME
--snapshot_uuid SNAPSHOT_UUID
--type TYPE
--persistent PERSISTENT
arguments:
-h, --help show this help message and exit
--name NAME - {{ no such element: dict object['desc'] }}
--snapshot_uuid SNAPSHOT_UUID - {{ no such element: dict object['desc'] }}
--type TYPE - Volume type ['cdrom', 'system', 'datablock']
--persistent PERSISTENT - Volume is persistent ['yes', 'no']
Import iso/qcow2 image to SP storage
storage sp volume import
> storage sp volume import [-h] --name NAME
[--descr DESCR]
--type TYPE
--template TEMPLATE
--persistent PERSISTENT
--path PATH
[--path_to PATH_TO]
arguments:
-h, --help show this help message and exit
--name NAME - The name of the volume
--descr DESCR - Volume description
--type TYPE - Volume type ['cdrom', 'system', 'datablock']
--template TEMPLATE - The template that the volume settings are inherited from
--persistent PERSISTENT - Volume is persistent ['yes', 'no']
--path PATH - Path to iso/qcow2 image (path folder or URL)
--path_to PATH_TO - Placing an object in the directory structure
List SP volumes
storage sp volume list
> storage sp volume list [-h] [--all ALL]
[--template TEMPLATE]
arguments:
-h, --help show this help message and exit
--all ALL - List all volumes ['yes', 'no']
--template TEMPLATE - {{ no such element: dict object['desc'] }}
Revert SP volume to snapshot
storage sp volume revert
> storage sp volume revert [-h] --uuid UUID
--snapshot_uuid SNAPSHOT_UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
--snapshot_uuid SNAPSHOT_UUID - Snapshot uuid
Show SP volume
storage sp volume show
> storage sp volume show [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
Update SP volume
storage sp volume update
> storage sp volume update [-h] --uuid UUID
[--name NAME]
[--descr DESCR]
[--bw BW]
[--iops IOPS]
[--reuse_server REUSE_SERVER]
[--size SIZE]
[--type TYPE]
[--persistent PERSISTENT]
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
--name NAME - Volume name
--descr DESCR - Volume description
--bw BW - Bandwidth limit in KB
--iops IOPS - Iops limit
--reuse_server REUSE_SERVER - Allow placement of replicas on same server
--size SIZE - The volume size.
--type TYPE - Volume type ['cdrom', 'system', 'datablock']
--persistent PERSISTENT - Volume type ['yes', 'no']
Update the used status for SP volume
storage sp volume used update
> storage sp volume used update [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Volume UUID
updater plugin
Add Updater params
updater param add
> updater param add [-h] [--enable ENABLE]
[--mods MODS]
[--profile PROFILE]
[--cron CRON]
arguments:
-h, --help show this help message and exit
--enable ENABLE - Network type ['yes', 'no']
--mods MODS - List of plugins/components
--profile PROFILE - Schema profile ['dev', 'prod']
--cron CRON - CRON schedule
Delete Updater params
updater param del
Show Updater params
updater param show
Update Updater params
updater param update
> updater param update [-h] [--enable ENABLE]
[--mods MODS]
[--profile PROFILE]
[--cron CRON]
arguments:
-h, --help show this help message and exit
--enable ENABLE - Network type ['yes', 'no']
--mods MODS - List of plugins/components
--profile PROFILE - Schema profile ['dev', 'prod']
--cron CRON - CRON schedule
Add update task
updater update add
> updater update add [-h] [--node NODE]
[--mods MODS]
arguments:
-h, --help show this help message and exit
--node NODE - Node name
--mods MODS - List of plugins/components
Clear update task
updater update clear
> updater update clear [-h] --uuid UUID
arguments:
-h, --help show this help message and exit
--uuid UUID - Task UUID
List all updates
updater update list
Show update
updater update show