CLI v2 Reference (technical preview)
Name
vc -
Synopsis
vc [COMMAND]
Description
Commands
login
logout
ve
VIRTUAL ENVIRONMENTS
storage
STORAGE MANAGEMENT
cloud
CLOUD MANAGEMENT
app
APPLICATION MANAGEMENT
node
NODES MANAGEMENT
bd
BACKUP DESTINATION MANAGEMENT
access
ACCESS MANAGEMENT
task
TASK MANAGEMENT
Name
vc-login -
Synopsis
vc login [-p=<password>] -u=<userName>
Description
Options
-p, password=<password>*
password
-u, user=<userName>*
userName
Name
vc-logout -
Synopsis
vc logout ([-u] | [-n])
Description
Options
-n,
Logout user
-u,
Logout user
Name
vc-access - ACCESS MANAGEMENT
Synopsis
vc access [COMMAND]
Description
ACCESS MANAGEMENT
Commands
user
User instances
group
AppUser Group instances
role
AppUser Role instances
os
OS credentials
Name
vc-access-group-addrole - Add role to the group (-gg | -gn ) -r
Synopsis
vc access group addrole -r=<roleGuid> (-gg=<guid> | -gn=<name>)
Description
Add role to the group (-gg <GUID> | -gn <NAME>) -r <ROLE_GUID>
Options
-gg,group-guid=<guid>
User group guid
-gn,group-name=<name>
User group name
-r, role*=<roleGuid>
Name
vc-access-group-adduser - Add user to the group (-gg | -gn ) -u
Synopsis
vc access group adduser -u=<userGuid> (-gg=<guid> | -gn=<name>)
Description
Add user to the group (-gg <GUID> | -gn <NAME>) -u <USER_GUID>
Options
-gg,group-guid=<guid>
User group guid
-gn,group-name=<name>
User group name
-u, user=<userGuid>*
User GUID
Name
vc-access-group-create - Create group
Synopsis
vc access group create <name>
Description
Create group <NAME>
Arguments
<name>
Name
vc-access-group-delete - Delete group (-gg | -gn )
Synopsis
vc access group delete (-gg=<guid> | -gn=<name>)
Description
Delete group (-gg <GUID> | -gn <NAME>)
Options
-gg,group-guid=<guid>
User group guid
-gn,group-name=<name>
User group name
Name
vc-access-group-details - Show group details (-gg | -gn )
Synopsis
vc access group details (-gg=<guid> | -gn=<name>)
Description
Show group details (-gg <GUID> | -gn <NAME>)
Options
-gg,group-guid=<guid>
User group guid
-gn,group-name=<name>
User group name
Name
vc-access-group-list - Show group list
Synopsis
vc access group list [-h=<noHeaders>]
Description
Show group list
Options
-h, no-headers=<noHeaders>*
Name
vc-access-group - AppUser Group instances
Synopsis
vc access group [COMMAND]
Description
AppUser Group instances
Commands
addrole
Add role to the group (-gg <GUID> | -gn <NAME>) -r <ROLE_GUID>
adduser
Add user to the group (-gg <GUID> | -gn <NAME>) -u <USER_GUID>
create
Create group <NAME>
delete
Delete group (-gg <GUID> | -gn <NAME>)
details
Show group details (-gg <GUID> | -gn <NAME>)
list
Show group list
removerole
Remove role from the group (-gg <GUID> | -gn <NAME>) -r <ROLE_GUID>
removeuser
Remove user from the group (-gg <GUID> | -gn <NAME>) -u <USER_GUID>
update
Add role to the group (-gg <GUID> | -gn <NAME>) -n <NAME>
Name
vc-access-group-removerole - Remove role from the group (-gg | -gn ) -r
Synopsis
vc access group removerole (-gg=<guid> | -gn=<name>) (-rg=<guid> | -rn=<name>)
Description
Remove role from the group (-gg <GUID> | -gn <NAME>) -r <ROLE_GUID>
Options
-gg,group-guid=<guid>
User group guid
-gn,group-name=<name>
User group name
-rg,user-role-guid=<guid>
User role guid
-rn,user-role-name=<name>
User role name
Name
vc-access-group-removeuser - Remove user from the group (-gg | -gn ) -u
Synopsis
vc access group removeuser (-gg=<guid> | -gn=<name>) (-ug=<guid> | -un=<name>)
Description
Remove user from the group (-gg <GUID> | -gn <NAME>) -u <USER_GUID>
Options
-gg,group-guid=<guid>
User group guid
-gn,group-name=<name>
User group name
-ug,user-guid=<guid>
User guid
-un,user-name=<name>
User name
Name
vc-access-group-update - Add role to the group (-gg | -gn ) -n
Synopsis
vc access group update -n=<name> (-gg=<guid> | -gn=<name>)
Description
Add role to the group (-gg <GUID> | -gn <NAME>) -n <NAME>
Options
-gg,group-guid=<guid>
User group guid
-gn,group-name=<name>
User group name
-n, name=<name>*
Name
vc-access-os-con - List all possible context types
Synopsis
vc access os con
Description
List all possible context types
Name
vc-access-os - OS credentials
Synopsis
vc access os [COMMAND]
Description
OS credentials
Commands
con
List all possible context types
pri
List all possible privilege types
Name
vc-access-os-pri - List all possible privilege types
Synopsis
vc access os pri
Description
List all possible privilege types
Name
vc-access-role-context - Add context to role (-rg | -rn )
Synopsis
vc access role context (-rg=<guid> | -rn=<name>)
Description
Add context to role (-rg <GUID> | -rn <NAME>)
Options
-rg,user-role-guid=<guid>
User role guid
-rn,user-role-name=<name>
User role name
Name
vc-access-role-create - Create role
Synopsis
vc access role create <name>
Description
Create role <NAME>
Arguments
<name>
Name
vc-access-role-delete - Delete role (-rg | -rn )
Synopsis
vc access role delete (-rg=<guid> | -rn=<name>)
Description
Delete role (-rg <GUID> | -rn <NAME>)
Options
-rg,user-role-guid=<guid>
User role guid
-rn,user-role-name=<name>
User role name
Name
vc-access-role-details - Show role details (-rg | -rn )
Synopsis
vc access role details (-rg=<guid> | -rn=<name>)
Description
Show role details (-rg <GUID> | -rn <NAME>)
Options
-rg,user-role-guid=<guid>
User role guid
-rn,user-role-name=<name>
User role name
Name
vc-access-role-listc - List contexts of the role (-rg | -rn )
Synopsis
vc access role listc [-h=<noHeaders>] (-rg=<guid> | -rn=<name>)
Description
List contexts of the role (-rg <GUID> | -rn <NAME>)
Options
-rg,user-role-guid=<guid>
User role guid
-rn,user-role-name=<name>
User role name
-h, no-headers=<noHeaders>
Name
vc-access-role-list - Roles list
Synopsis
vc access role list [-h=<noHeaders>]
Description
Roles list <GUID>
Options
-h, no-headers=<noHeaders>
Name
vc-access-role - AppUser Role instances
Synopsis
vc access role [COMMAND]
Description
AppUser Role instances
Commands
context
Add context to role (-rg <GUID> | -rn <NAME>)
privilege
Add privilege to role (-rg <GUID> | -rn <NAME>) -p <PRIVILEGE_NAME>
create
Create role <NAME>
delete
Delete role (-rg <GUID> | -rn <NAME>)
details
Show role details (-rg <GUID> | -rn <NAME>)
list
Roles list <GUID>
listc
List contexts of the role (-rg <GUID> | -rn <NAME>)
removep
Remove privilege from the role (-rg <GUID> | -rn <NAME>) -i <PRIVILEGE_NAME>
removec
Remove context from the role (-rg <GUID> | -rn <NAME>) -i <CONTEXT_INSTANCE_GUID>
update
Modify role name (-rg <GUID> | -rn <NAME>) -n <NAME>
Name
vc-access-role-privilege - Add privilege to role (-rg | -rn ) -p
Synopsis
vc access role privilege -p=<privilegeName> (-rg=<guid> | -rn=<name>)
Description
Add privilege to role (-rg <GUID> | -rn <NAME>) -p <PRIVILEGE_NAME>
Options
-rg,user-role-guid=<guid>
User role guid
-rn,user-role-name=<name>
User role name
-p, privilege=<privilegeName>
Privilege name
Name
vc-access-role-removec - Remove context from the role (-rg | -rn ) -i
Synopsis
vc access role removec ii=<instanceGuid> (-rg=<guid> | -rn=<name>)
Description
Remove context from the role (-rg <GUID> | -rn <NAME>) -i <CONTEXT_INSTANCE_GUID>
Options
-rg,user-role-guid=<guid>
User role guid
-rn,user-role-name=<name>
User role name
ii, instance=<instanceGuid>
Name
vc-access-role-removep - Remove privilege from the role (-rg | -rn ) -i
Synopsis
vc access role removep -n=<namePrivilege> (-rg=<guid> | -rn=<name>)
Description
Remove privilege from the role (-rg <GUID> | -rn <NAME>) -i <PRIVILEGE_NAME>
Options
-rg,user-role-guid=<guid>
User role guid
-rn,user-role-name=<name>
User role name
-n, name=<namePrivilege>
Name
vc-access-role-update - Modify role name (-rg | -rn ) -n
Synopsis
vc access role update -n=<name> (-rg=<guid> | -rn=<name>)
Description
Modify role name (-rg <GUID> | -rn <NAME>) -n <NAME>
Options
-rg,user-role-guid=<guid>
User role guid
-rn,user-role-name=<name>
User role name
-n, name=<name>
New name
Name
vc-access-user-active - Update user activation state (-ug | -un ) -a
Synopsis
vc access user active -a=<active> (-ug=<guid> | -un=<name>)
Description
Update user activation state (-ug <GUID> | -un <NAME>) -a <ACTIVE>
Options
-ug,user-guid=<guid>
User guid
-un,user-name=<name>
User name
-a, active=<active>
YES or NO
Name
vc-access-user-create - Create user -l -n -ln -t -la -a
Synopsis
vc access user create -a=<active> -l=<login> -la=<language> -ln=<lastName> -n=<name> -t=<timeZone>
Description
Create user -l <LOGIN> -n <FIRST_NAME> -ln <LAST_NAME> -t <TIME_ZONE> -la <LANGUAGE> -a <ACTIVE(YES|NO)>
Options
-l, login=<login>
-n, name=<name>
-ln,last-name=<lastName>
-t, time-zone=<timeZone>
-la,language=<language>
-a, active=<active>
YES or NO
Name
vc-access-user-delete - Delete user (-ug | -un )
Synopsis
vc access user delete (-ug=<guid> | -un=<name>)
Description
Delete user (-ug <GUID> | -un <NAME>)
Options
-ug,user-guid=<guid>
User guid
-un,user-name=<name>
User name
Name
vc-access-user-details - Show user details (-ug | -un )
Synopsis
vc access user details (-ug=<guid> | -un=<name>)
Description
Show user details (-ug <GUID> | -un <NAME>)
Options
-ug,user-guid=<guid>
User guid
-un,user-name=<name>
User name
Name
vc-access-user-list -
Synopsis
vc access user list [-h=<noHeaders>]
Description
Options
-h, no-headers=<noHeaders>
Name
vc-access-user - User instances
Synopsis
vc access user [COMMAND]
Description
User instances
Commands
create
Create user -l <LOGIN> -n <FIRST_NAME> -ln <LAST_NAME> -t <TIME_ZONE> -la <LANGUAGE> -a <ACTIVE(YES|NO)>
delete
Delete user (-ug <GUID> | -un <NAME>)
details
Show user details (-ug <GUID> | -un <NAME>)
list
active
Update user activation state (-ug <GUID> | -un <NAME>) -a <ACTIVE>
update
Update user (-ug <GUID> | -un <NAME>) -p <PROPERTY_NAME> -v <VALUE>
password
Update user password (-ug <GUID> | -un <NAME>)
settings
Update user settings (-ug <GUID> | -un <NAME>) -p <PROPERTY_NAME> -v <VALUE>
Name
vc-access-user-password - Update user password (-ug | -un )
Synopsis
vc access user password (-ug=<guid> | -un=<name>)
Description
Update user password (-ug <GUID> | -un <NAME>)
Options
-ug,user-guid=<guid>
User guid
-un,user-name=<name>
User name
Name
vc-access-user-settings - Update user settings (-ug | -un ) -p -v
Synopsis
vc access user settings -p=<number> -v=<value> (-ug=<guid> | -un=<name>)
Description
Update user settings (-ug <GUID> | -un <NAME>) -p <PROPERTY_NAME> -v <VALUE>
Options
-ug,user-guid=<guid>
User guid
-un,user-name=<name>
User name
-p, property*=<number>
Names: PAGE_SIZE, TIME_FORMAT, UNMOUNT_PERIOD
-v, value*=<value>
Name
vc-access-user-update - Update user (-ug | -un ) -p -v
Synopsis
vc access user update -p=<number> -v=<value> (-ug=<guid> | -un=<name>)
Description
Update user (-ug <GUID> | -un <NAME>) -p <PROPERTY_NAME> -v <VALUE>
Options
-ug,user-guid=<guid>
User guid
-un,user-name=<name>
User name
-p, property*=<number>
Names: FIRSTNAME, LASTNAME, UITIMEZONE, LANGUAGE, ACTIVE
-v, value*=<value>
Name
vc-app - APPLICATION MANAGEMENT
Synopsis
vc app [COMMAND]
Description
APPLICATION MANAGEMENT
Commands
inst
Application instances
config
Application execution configurations
backup
Backup SLA
Name
vc-app-backup - Backup SLA
Synopsis
vc app backup [COMMAND]
Description
Backup SLA
Commands
policy
Application backup policy commands
schedule
Policy schedule commands
Name
vc-app-backup-policy - Application backup policy commands
Synopsis
vc app backup policy [COMMAND]
Description
Application backup policy commands
Commands
assign
Assign applications to policy (-pg <GUID> | -pn <NAME>) -a <APP_GUID>,…,<APP_GUID>
addrule
Add new rule to selected policy
create
Create application backup policy -n <NAME> -p <PRIORITY>
delete
Delete application backup policy (-pg <GUID> | -pn <NAME>)
details
Show application backup policy details (-pg <GUID> | -pn <NAME>)
list
List backup policies
listrules
List rules for application backup policy (-pg <GUID> | -pn <NAME>)
addbd
Add backup destination for the VM policy (-pg <GUID> | -pn <NAME>) -b <BD_GUID> -r <ROLE>
removebd
Remove backup destination from the VM policy -g <GUID> -b <BD_GUID>
remove
Remove rules from policy (-pg <GUID> | -pn <NAME>) -a <RULE_GUID>,…,<RULE_GUID>
unassign
Unassign applications from policy (-pg <GUID> | -pn <NAME>) -a <APP_GUID>,…,<APP_GUID>
update
Modify application backup policy (-pg <GUID> | -pn <NAME>)
Name
vc-app-backup-policy-addbd - Add backup destination for the VM policy (-pg | -pn ) -b -r
Synopsis
vc app backup policy addbd -b=<bdGuid> -r=<role> (-pg=<policyGuid> | -pn=<policyName>)
Description
Add backup destination for the VM policy (-pg <GUID> | -pn <NAME>) -b <BD_GUID> -r <ROLE>
Options
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
-b, backup-destination*=<bdGuid>
Backup destination GUID
-r, role*=<role>
Types: PRIMARY, SECONDARY, ARCHIVE
Name
vc-app-backup-policy-addrule - Add new rule to selected policy
Synopsis
vc app backup policy addrule -b=<bdGuid> -k=<keep> -n=<name> -rf=<fullDays> -ri=<incDays> -s=<scheduleGuid> -vf=<fullVersion> -vi=<incVersion> (-pg=<policyGuid> | -pn=<policyName>)
Description
Add new rule to selected policy
Options
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
-n, name=<name>
-s, schedule*=<scheduleGuid>
Schedule GUID
-b, bd*=<bdGuid>
Backup destination GUID
-rf,days-full=<fullDays>
Number of days to keep FULL backup
-vf,version-full=<fullVersion>
Number of version to keep FULL backup
-ri,days-inc=<incDays>
Number of days to keep INCREMENTAL backup
-vi,version-inc=<incVersion>
Number of version to keep INCREMENTAL backup
-k, keep*=<keep>
Keep last backup when source still exists? (YES or NO)
Name
vc-app-backup-policy-assign - Assign applications to policy (-pg | -pn ) -a ,...,
Synopsis
vc app backup policy assign -a=<apps>[,<apps>…] [-a=<apps>[,<apps>…]]… (-pg=<policyGuid> | -pn=<policyName>)
Description
Assign applications to policy (-pg <GUID> | -pn <NAME>) -a <APP_GUID>,…,<APP_GUID>
Options
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
-a, app*=<apps>[,<apps>…]
Applications GUIDs (no spaces)
Name
vc-app-backup-policy-create - Create application backup policy -n -p
Synopsis
vc app backup policy create -n=<name> -p=<priority>
Description
Create application backup policy -n <NAME> -p <PRIORITY>
Options
-n, name=<name>
-p, priority*=<priority>
Range 0-100
Name
vc-app-backup-policy-delete - Delete application backup policy (-pg | -pn )
Synopsis
vc app backup policy delete (-pg=<policyGuid> | -pn=<policyName>)
Description
Delete application backup policy (-pg <GUID> | -pn <NAME>)
Options
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
Name
vc-app-backup-policy-details - Show application backup policy details (-pg | -pn )
Synopsis
vc app backup policy details (-pg=<policyGuid> | -pn=<policyName>)
Description
Show application backup policy details (-pg <GUID> | -pn <NAME>)
Options
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
Name
vc-app-backup-policy-list - List backup policies
Synopsis
vc app backup policy list [-h=<noHeaders>]
Description
List backup policies
Options
-h, no-headers=<noHeaders>
Name
vc-app-backup-policy-listrules - List rules for application backup policy (-pg | -pn )
Synopsis
vc app backup policy listrules [-h=<noHeaders>] (-pg=<policyGuid> | -pn=<policyName>)
Description
List rules for application backup policy (-pg <GUID> | -pn <NAME>)
Options
-h, no-headers=<noHeaders>
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
Name
vc-app-backup-policy-removebd - Remove backup destination from the VM policy -g -b
Synopsis
vc app backup policy removebd -b=<bdGuid> -r=<role> (-pg=<policyGuid> | -pn=<policyName>)
Description
Remove backup destination from the VM policy -g <GUID> -b <BD_GUID>
Options
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
-b, backup-destination*=<bdGuid>
Backup destination GUID
-r, role*=<role>
Types: PRIMARY, SECONDARY, ARCHIVE
Name
vc-app-backup-policy-remove - Remove rules from policy (-pg | -pn ) -a ,...,
Synopsis
vc app backup policy remove -r=<rules>[,<rules>…] [-r=<rules>[, <rules>…]]… (-pg=<policyGuid> | -pn=<policyName>)
Description
Remove rules from policy (-pg <GUID> | -pn <NAME>) -a <RULE_GUID>,...,<RULE_GUID>
Options
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
-r, rule*=<rules>[,<rules>…]
Rule GUIDs (no spaces)
Name
vc-app-backup-policy-unassign - Unassign applications from policy (-pg | -pn ) -a ,...,
Synopsis
vc app backup policy unassign -a=<apps>[,<apps>…] [-a=<apps>[,<apps>…]]… (-pg=<policyGuid> | -pn=<policyName>)
Description
Unassign applications from policy (-pg <GUID> | -pn <NAME>) -a <APP_GUID>,…,<APP_GUID>
Options
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
-a, app*=<apps>[,<apps>…]
<GUID>,…,<GUID> (no spaces)
Name
vc-app-backup-policy-update - Modify application backup policy (-pg | -pn )
Synopsis
vc app backup policy update -n=<name> -p=<priority> (-pg=<policyGuid> | -pn=<policyName>)
Description
Modify application backup policy (-pg <GUID> | -pn <NAME>)
Options
-pg,policy-guid=<policyGuid>
App backup policy guid
-pn,policy-name=<policyName>
App backup policy name
-n, name=<name>
New name GUID
-p, priority*=<priority>
Default 50, scope 0-100
Name
vc-app-backup-schedule - Policy schedule commands
Synopsis
vc app backup schedule [COMMAND]
Description
Policy schedule commands
Commands
list
List application schedules
create
Create new schedule
delete
Delete schedule <GUID>
details
Show schedule details <GUID>
active
Set schedule to be active (YES or NO) -g <GUID> -a <ACTIVE>
update
Update schedule
Name
vc-app-backup-schedule-active - Set schedule to be active (YES or NO) -g -a
Synopsis
vc app backup schedule active -a=<active> -g=<guid>
Description
Set schedule to be active (YES or NO) -g <GUID> -a <ACTIVE>
Options
-g, guid=<guid>
User GUID
-a, active=<active>
YES or NO
Name
vc-app-backup-schedule-create - Create new schedule
Synopsis
vc app backup schedule create [-a=<active>] -b=<backupType> -d=<duration> -e=<scheduleExecutionType> -n=<name> -t=<time> -dw=<daysOfWeek>[,<daysOfWeek>…] [-dw=<daysOfWeek>[,<daysOfWeek>…]]… -m=<months>[,<months>…] [-m=<months>[, <months>…]]… -o=<occurrence>[, <occurrence>…] [-o=<occurrence>[, <occurrence>…]]…
Description
Create new schedule
Options
-n, name=<name>
-b, backup-type=<backupType>
Types: FULL, INCREMENTAL, SYNTHETIC, SYNCHRONIZATION
-e, exec-type*=<scheduleExecutionType>
Schedule exec type. Types: TIME, INTERVAL
-t, time=<time>
<START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR> <HH:mm | HH:mm-HH:mm>
-d, duration=<duration>
<DURATION | INTERVAL_FREQUENCY>
-dw,days-of-week=<daysOfWeek>[,<daysOfWeek>…]
<EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY> (no spaces)
-o, occurrence=<occurrence>[,<occurrence>…]
<ANY, FIRST_IN_MONTH, SECOND_IN_MONTH, THIRD_IN_MONTH, FOURTH_IN_MONTH, LAST_IN_MONTH> (no spaces)
-m, months=<months>[,<months>…]
<ANY, JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER> (no spaces)
-a, active=<active>
Active by default. No - to create disable
Name
vc-app-backup-schedule-delete - Delete schedule
Synopsis
vc app backup schedule delete (-sg=<scheduleGuid> | -sn=<scheduleName>)
Description
Delete schedule <GUID>
Options
-sg,schedule-guid=<scheduleGuid>
App backup schedule guid
-sn,schedule-name=<scheduleName>
App backup schedule name
Name
vc-app-backup-schedule-details - Show schedule details
Synopsis
vc app backup schedule details <guid>
Description
Show schedule details <GUID>
Arguments
<guid>
Name
vc-app-backup-schedule-list - List application schedules