CLI v2 Reference (technical preview)

vc

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

vc-login

Name

vc-login -

Synopsis

vc login [-p=<password>] -u=<userName>

Description

Options

-p, *password=<password> password

-u, *user=<userName> userName

vc-logout

Name

vc-logout -

Synopsis

vc logout ([-u] | [-n])

Description

Options

-n, Logout user

-u, Logout user

vc-access

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

vc-access-group-addrole

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>*

vc-access-group-adduser

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

vc-access-group-create

Name

vc-access-group-create - Create group

Synopsis

vc access group create <name>

Description

Create group <NAME>

Arguments

<name>

vc-access-group-delete

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

vc-access-group-details

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

vc-access-group-list

Name

vc-access-group-list - Show group list

Synopsis

vc access group list [-h=<noHeaders>]

Description

Show group list

Options

-h, *no-headers=<noHeaders>

vc-access-group

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>

vc-access-group-removerole

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

vc-access-group-removeuser

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

vc-access-group-update

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>

vc-access-os-con

Name

vc-access-os-con - List all possible context types

Synopsis

vc access os con

Description

List all possible context types

vc-access-os

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

vc-access-os-pri

Name

vc-access-os-pri - List all possible privilege types

Synopsis

vc access os pri

Description

List all possible privilege types

vc-access-role-context

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

vc-access-role-create

Name

vc-access-role-create - Create role

Synopsis

vc access role create <name>

Description

Create role <NAME>

Arguments

<name>

vc-access-role-delete

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

vc-access-role-details

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

vc-access-role-listc

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>

vc-access-role-list

Name

vc-access-role-list - Roles list

Synopsis

vc access role list [-h=<noHeaders>]

Description

Roles list <GUID>

Options

-h, no-headers=<noHeaders>

vc-access-role

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>

vc-access-role-privilege

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

vc-access-role-removec

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>

vc-access-role-removep

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>

vc-access-role-update

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

vc-access-user-active

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

vc-access-user-create

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

vc-access-user-delete

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

vc-access-user-details

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

vc-access-user-list

Name

vc-access-user-list -

Synopsis

vc access user list [-h=<noHeaders>]

Description

Options

-h, no-headers=<noHeaders>

vc-access-user

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>

vc-access-user-password

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

vc-access-user-settings

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>*

vc-access-user-update

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>*

vc-app

Name

vc-app - APPLICATION MANAGEMENT

Synopsis

vc app [COMMAND]

Description

APPLICATION MANAGEMENT

Commands

inst

Application instances

config

Application execution configurations

backup

Backup SLA

vc-app-backup

Name

vc-app-backup - Backup SLA

Synopsis

vc app backup [COMMAND]

Description

Backup SLA

Commands

policy

Application backup policy commands

schedule

Policy schedule commands

vc-app-backup-policy

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>)

vc-app-backup-policy-addbd

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

vc-app-backup-policy-addrule

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)

vc-app-backup-policy-assign

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)

vc-app-backup-policy-create

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

vc-app-backup-policy-delete

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

vc-app-backup-policy-details

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

vc-app-backup-policy-list

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>

vc-app-backup-policy-listrules

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

vc-app-backup-policy-removebd

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

vc-app-backup-policy-remove

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)

vc-app-backup-policy-unassign

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)

vc-app-backup-policy-update

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

vc-app-backup-schedule

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

vc-app-backup-schedule-active

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

vc-app-backup-schedule-create

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

vc-app-backup-schedule-delete

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

vc-app-backup-schedule-details

Name

vc-app-backup-schedule-details - Show schedule details

Synopsis

vc app backup schedule details <guid>

Description

Show schedule details <GUID>

Arguments

<guid>

vc-app-backup-schedule-list

Name

vc-app-backup-schedule-list - List application schedules

Synopsis

vc app backup schedule list [-h=<noHeaders>]

Description

List application schedules

Options

-h, no-headers=<noHeaders>

vc-app-backup-schedule-update

Name

vc-app-backup-schedule-update - Update schedule

Synopsis

vc app backup schedule update -b=<backupType> -d=<duration> -g=<guid> -n=<name> -se=<scheduleExecutionType> -t=<time> -dw=<daysOfWeek> [-dw=<daysOfWeek>]…​ -m=<months> [-m=<months>]…​ -o=<occurrence> [-o=<occurrence>]…​

Description

Update schedule

Options

-g, guid=<guid> -n, name=<name> -b, backup-type=<backupType> Types: FULL, INCREMENTAL, SYNTHETIC, SYNCHRONIZATION

-se,exec-type=<scheduleExecutionType> Schedule exec type. Types: TIME, INTERVAL

-t, time=<time> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR>

-d, duration=<duration> <DURATION | INTERVAL_FREQUENCY>

-dw,days-of-week=<daysOfWeek> <EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY>

-o, occurrence=<occurrence> <ANY, FIRST_IN_MONTH, SECOND_IN_MONTH, THIRD_IN_MONTH, FOURTH_IN_MONTH, LAST_IN_MONTH>

-m, months=<months> <ANY, JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER>

vc-app-config

Name

vc-app-config - Application execution configurations

Synopsis

vc app config [COMMAND]

Description

Application execution configurations

Commands

assign

Assign applications to config (-ag <GUID> | -an <NAME>) -a <APP_GUID>,…​,<APP_GUID>

unassign

Unassign applications from config -a <APP_GUID>,…​,<APP_GUID>

create

Create application command execution config -n <NAME> -m <METHOD> -t <TYPE> -t <TIMEOUT>

delete

Delete application command execution config (-ag <GUID> | -an <NAME>)

details

Show details (-ag <GUID> | -an <NAME>)

list

List application command execution configs

update

Modify application command execution config (-ag <GUID> | -an <NAME>) -n <NAME> -m <METHOD> -t <TYPE>

remove

Remove files after export (-ag <GUID> | -an <NAME>) -r <YES | NO>

vc-app-config-assign

Name

vc-app-config-assign - Assign applications to config (-ag | -an ) -a ,...,

Synopsis

vc app config assign -a=<apps>[,<apps>…​] [-a=<apps>[,<apps>…​]]…​ (-ag=<guid> | -an=<name>)

Description

Assign applications to config (-ag <GUID> | -an <NAME>) -a <APP_GUID>,…​,<APP_GUID>

Options

-ag,app-cmd-guid=<guid> Application cmd guid

-an,app-cmd-name=<name> Application cmd name

-a, app**=<apps>[,<apps>*…​] GUID,…​,GUID (No spaces)

vc-app-config-create

Name

vc-app-config-create - Create application command execution config -n -m -t -t

Synopsis

vc app config create -m=<method> -n=<name> -t=<type> -to=<timeOut>

Description

Create application command execution config -n <NAME> -m <METHOD> -t <TYPE> -t <TIMEOUT>

Options

-n, name=<name> -m, method**=<method>* Types: NODE, REMOTE_SSH, REMOTE_POWERSHELL

-t, type**=<type>* Types: FILE, STREAM

-to,timeout=<timeOut> [minutes]

vc-app-config-delete

Name

vc-app-config-delete - Delete application command execution config (-ag | -an )

Synopsis

vc app config delete (-ag=<guid> | -an=<name>)

Description

Delete application command execution config (-ag <GUID> | -an <NAME>)

Options

-ag,app-cmd-guid=<guid> Application cmd guid

-an,app-cmd-name=<name> Application cmd name

vc-app-config-details

Name

vc-app-config-details - Show details (-ag | -an )

Synopsis

vc app config details (-ag=<guid> | -an=<name>)

Description

Show details (-ag <GUID> | -an <NAME>)

Options

-ag,app-cmd-guid=<guid> Application cmd guid

-an,app-cmd-name=<name> Application cmd name

vc-app-config-list

Name

vc-app-config-list - List application command execution configs

Synopsis

vc app config list [-h=<noHeaders>]

Description

List application command execution configs

Options

-h, no-headers=<noHeaders>

vc-app-config-remove

Name

vc-app-config-remove - Remove files after export (-ag | -an ) -r

Synopsis

vc app config remove -r=<remove> (-ag=<guid> | -an=<name>)

Description

Remove files after export (-ag <GUID> | -an <NAME>) -r <YES | NO>

Options

-ag,app-cmd-guid=<guid> Application cmd guid

-an,app-cmd-name=<name> Application cmd name

-r, remove**=<remove>* Remove <YES | NO>

vc-app-config-unassign

Name

vc-app-config-unassign - Unassign applications from config -a ,...,

Synopsis

vc app config unassign -a=<apps>[,<apps>…​] [-a=<apps>[,<apps>…​]]…​

Description

Unassign applications from config -a <APP_GUID>,…​,<APP_GUID>

Options

-a, app**=<apps>[,<apps>*…​] GUID,…​,GUID (No spaces)

vc-app-config-update

Name

vc-app-config-update - Modify application command execution config (-ag | -an ) -n -m -t

Synopsis

vc app config update [-m=<method>] [-n=<name>] [-t=<type>] (-ag=<guid> | -an=<name>)

Description

Modify application command execution config (-ag <GUID> | -an <NAME>) -n <NAME> -m <METHOD> -t <TYPE>

Options

-ag,app-cmd-guid=<guid> Application cmd guid

-an,app-cmd-name=<name> Application cmd name

-n, name=<name> New name

-m, method**=<method>* Types: NODE, REMOTE_SSH, REMOTE_POWERSHELL

-t, type**=<type>* Types: FILE, STREAM

vc-app-inst

Name

vc-app-inst - Application instances

Synopsis

vc app inst [COMMAND]

Description

Application instances

Commands

mg

Application instances management

bar

Application backup & restore policy

vc-app-inst-bar

Name

vc-app-inst-bar - Application backup & restore policy

Synopsis

vc app inst bar [COMMAND]

Description

Application backup & restore policy

Commands

list

List recovery plan policies and rules

full

Backup (full) (-pg <GUID> | -pn <NAME>) -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

fullp

Backup (full) with task priority (-pg <GUID> | -pn <NAME>)-p <PRIORITY> -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

details

Show details -bg <GUID>

file

Show file details -bg <GUID>

status

Show backup status info -bg <GUID>

restore

Restore the backup from backup location -g <BACKUP_LOCATION_GUID> -p <PATH>

import

Restore and import backup -bg <BACKUP_GUID> -d <DST_APP_GUID> -p <PATH>

vc-app-inst-bar-details

Name

vc-app-inst-bar-details - Show details -bg

Synopsis

vc app inst bar details -bg=<guid>

Description

Show details -bg <GUID>

Options

-bg,backup-guid=<guid> Backup guid

vc-app-inst-bar-file

Name

vc-app-inst-bar-file - Show file details -bg

Synopsis

vc app inst bar file -bg=<guid>

Description

Show file details -bg <GUID>

Options

-bg,backup-guid=<guid> Backup guid

vc-app-inst-bar-full

Name

vc-app-inst-bar-full - Backup (full) (-pg | -pn ) -r ,...,

Synopsis

vc app inst bar full -r=<backupRules>[,<backupRules>…​] [-r=<backupRules>[, <backupRules>…​]]…​ (-pg=<policyGuid> | -pn=<policyName>)

Description

Backup (full) (-pg <GUID> | -pn <NAME>) -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

Options

-pg,policy-guid=<policyGuid> App backup policy guid

-pn,policy-name=<policyName> App backup policy name

-r, backup-rule**=<backupRules>[,<backupRules>*…​] GUID,…​,GUID (No spaces)

vc-app-inst-bar-fullp

Name

vc-app-inst-bar-fullp - Backup (full) with task priority (-pg | -pn )-p -r ,...,

Synopsis

vc app inst bar fullp -p=<priority> -r=<backupRules>[,<backupRules>…​] [-r=<backupRules>[,<backupRules>…​]]…​ (-pg=<policyGuid> | -pn=<policyName>)

Description

Backup (full) with task priority (-pg <GUID> | -pn <NAME>)-p <PRIORITY> -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

Options

-pg,policy-guid=<policyGuid> App backup policy guid

-pn,policy-name=<policyName> App backup policy name

-r, backup-rule**=<backupRules>[,<backupRules>*…​] GUID,…​,GUID (No spaces)

-p, priority**=<priority>* Range 0-100

vc-app-inst-bar-import

Name

vc-app-inst-bar-import - Restore and import backup -bg -d -p

Synopsis

vc app inst bar import -bg=<guid> -d=<dstAppGuid> -p=<path>

Description

Restore and import backup -bg <BACKUP_GUID> -d <DST_APP_GUID> -p <PATH>

Options

-bg,backup-guid=<guid> Backup guid

-d, dst-guid**=<dstAppGuid>* Destination App GUID

-p, path=<path> Enter D as path for DEFAULT source path from application

vc-app-inst-bar-list-backup

Name

vc-app-inst-bar-list-backup - List backups

Synopsis

vc app inst bar list backup [-h=<noHeaders>]

Description

List backups

Options

-h, no-headers=<noHeaders>

vc-app-inst-bar-list-file

Name

vc-app-inst-bar-list-file - List backup files -bg

Synopsis

vc app inst bar list file -bg=<guid> [-h=<noHeaders>]

Description

List backup files -bg <BACKUP_GUID>

Options

-bg,backup-guid=<guid>

Backup guid

-h, no-headers=<noHeaders>

vc-app-inst-bar-list

Name

vc-app-inst-bar-list - List recovery plan policies and rules

Synopsis

vc app inst bar list [COMMAND]

Description

List recovery plan policies and rules

Commands

task

List tasks related to the backup -bg <BACKUP_GUID>

backup

List backups

file

List backup files -bg <BACKUP_GUID>

vc-app-inst-bar-list-task

Name

vc-app-inst-bar-list-task - List tasks related to the backup -bg

Synopsis

vc app inst bar list task -bg=<guid> [-h=<noHeaders>]

Description

List tasks related to the backup -bg <BACKUP_GUID>

Options

-bg,backup-guid=<guid>

Backup guid

-h, no-headers=<noHeaders>

vc-app-inst-bar-restore

Name

vc-app-inst-bar-restore - Restore the backup from backup location -g -p

Synopsis

vc app inst bar restore -g=<guid> -p=<path>

Description

Restore the backup from backup location -g <BACKUP_LOCATION_GUID> -p <PATH>

Options

-g, guid=<guid>

-p, path=<path>

vc-app-inst-bar-status

Name

vc-app-inst-bar-status - Show backup status info -bg

Synopsis

vc app inst bar status -bg=<guid>

Description

Show backup status info -bg <GUID>

Options

-bg,backup-guid=<guid> Backup guid

vc-app-inst-mg

Name

vc-app-inst-mg - Application instances management

Synopsis

vc app inst mg [COMMAND]

Description

Application instances management

Commands

list

List recovery plan policies and rules

set

Set recovery plan policies and rules

ap

Assign application backup policy (-ag <GUID> | -an <NAME>) -p <APP_POLICY_GUID>

addvar

Add environment variable to application (-ag <GUID> | -an <NAME>) -n <NAME> -v <VALUE>

delete

Delete an application (-ag <GUID> | -an <NAME>)

create

Create a new application -n <NAME> -g <NODE_CONFIG_GUID>

deletevar

Delete environment variable <GUID>

update

Modify application (-ag <GUID> | -an <NAME>) -n <NAME>

updatevar

Modify environment variable. Set variable hidden in UI: YES | NO -g <GUID> (-ag <GUID> | -an <NAME>) -n <NAME> -v <VALUE> -h <YES | NO>

details

Show application details (-ag <GUID> | -an <NAME>)

vc-app-inst-mg-addvar

Name

vc-app-inst-mg-addvar - Add environment variable to application (-ag | -an ) -n -v

Synopsis

vc app inst mg addvar -n=<name> -v=<value> (-ag=<guid> | -an=<name>)

Description

Add environment variable to application (-ag <GUID> | -an <NAME>) -n <NAME> -v <VALUE>

Options

-ag,app-guid=<guid>

Application guid

-an,app-name=<name>

Application name

-n, name=<name>

-v, value**=<value>*

vc-app-inst-mg-ap

Name

vc-app-inst-mg-ap - Assign application backup policy (-ag | -an ) -p

Synopsis

vc app inst mg ap -p=<policyGuid> (-ag=<guid> | -an=<name>)

Description

Assign application backup policy (-ag <GUID> | -an <NAME>) -p <APP_POLICY_GUID>

Options

-ag,app-guid=<guid>

Application guid

-an,app-name=<name>

Application name

-p, policy**=<policyGuid>*

vc-app-inst-mg-create

Name

vc-app-inst-mg-create - Create a new application -n -g

Synopsis

vc app inst mg create -n=<name> (-ncg=<guid> | -ncn=<name>)

Description

Create a new application -n <NAME> -g <NODE_CONFIG_GUID>

Options

-ncg,node-config-guid=<guid>

Node config guid

-ncn,node-config-name=<name>

Node config name

-n, name=<name>

vc-app-inst-mg-delete

Name

vc-app-inst-mg-delete - Delete an application (-ag | -an )

Synopsis

vc app inst mg delete (-ag=<guid> | -an=<name>)

Description

Delete an application (-ag <GUID> | -an <NAME>)

Options

-ag,app-guid=<guid> Application guid

-an,app-name=<name> Application name

vc-app-inst-mg-deletevar

Name

vc-app-inst-mg-deletevar - Delete environment variable

Synopsis

vc app inst mg deletevar <guid>

Description

Delete environment variable <GUID>

Arguments

<guid> Environment variable GUID

vc-app-inst-mg-details

Name

vc-app-inst-mg-details - Show application details (-ag | -an )

Synopsis

vc app inst mg details (-ag=<guid> | -an=<name>)

Description

Show application details (-ag <GUID> | -an <NAME>)

Options

-ag,app-guid=<guid> Application guid

-an,app-name=<name> Application name

vc-app-inst-mg-list-app

Name

vc-app-inst-mg-list-app - List applications

Synopsis

vc app inst mg list app [-h=<noHeaders>]

Description

List applications

Options

-h, no-headers=<noHeaders>

vc-app-inst-mg-list-backup

Name

vc-app-inst-mg-list-backup - List backups of the application (-ag | -an )

Synopsis

vc app inst mg list backup [-h=<noHeaders>] (-ag=<guid> | -an=<name>)

Description

List backups of the application (-ag <GUID> | -an <NAME>)

Options

-ag,app-guid=<guid>

Application guid

-an,app-name=<name>

Application name

-h, no-headers=<noHeaders>

vc-app-inst-mg-list

Name

vc-app-inst-mg-list - List recovery plan policies and rules

Synopsis

vc app inst mg list [COMMAND]

Description

List recovery plan policies and rules

Commands

app

List applications

backup

List backups of the application (-ag <GUID> | -an <NAME>)

var

List backups of the application (-ag <GUID> | -an <NAME>)

vc-app-inst-mg-list-var

Name

vc-app-inst-mg-list-var - List backups of the application (-ag | -an )

Synopsis

vc app inst mg list var [-h=<noHeaders>] (-ag=<guid> | -an=<name>)

Description

List backups of the application (-ag <GUID> | -an <NAME>)

Options

-ag,app-guid=<guid>

Application guid

-an,app-name=<name>

Application name

-h, no-headers=<noHeaders>

vc-app-inst-mg-set-cmd

Name

vc-app-inst-mg-set-cmd - Set application CMD exec configuration (-ag | -an )-c

Synopsis

vc app inst mg set cmd -c=<configGuid> (-ag=<guid> | -an=<name>)

Description

Set application CMD exec configuration (-ag <GUID> | -an <NAME>)-c <CONF_GUID>

Options

-ag,app-guid=<guid> Application guid

-an,app-name=<name> Application name

-c, conf**=<configGuid>* Command Execution Configuration Guid

vc-app-inst-mg-set

Name

vc-app-inst-mg-set - Set recovery plan policies and rules

Synopsis

vc app inst mg set [COMMAND]

Description

Set recovery plan policies and rules

Commands

cmd

Set application CMD exec configuration (-ag <GUID> | -an <NAME>)-c <CONF_GUID>

nc

Set node configuration for application (-ag <GUID> | -an <NAME>) -n <NODE_CONFIG_GUID>

sshcre

Set SSH access credentials -n <NAME> (-ag <GUID> | -an <NAME>)-u <SSH_USER> -p <SSH_PASSWORD>

sshhost

Set SSH access host/port (-ag <GUID> | -an <NAME>) -h <SSH_HOST> -p <SSH_PORT>

sshkey

Set SSH key path (-ag <GUID> | -an <NAME>) -p <SSH_KEYPATH>

vc-app-inst-mg-set-nc

Name

vc-app-inst-mg-set-nc - Set node configuration for application (-ag | -an ) -n

Synopsis

vc app inst mg set nc -n=<nodeConfigGuid> (-ag=<guid> | -an=<name>)

Description

Set node configuration for application (-ag <GUID> | -an <NAME>) -n <NODE_CONFIG_GUID>

Options

-ag,app-guid=<guid>

Application guid

-an,app-name=<name>

Application name

-n, node-config**=<nodeConfigGuid>*

vc-app-inst-mg-set-sshcre

Name

vc-app-inst-mg-set-sshcre - Set SSH access credentials -n (-ag | -an )-u -p

Synopsis

vc app inst mg set sshcre -n=<name> -p=<password> -u=<user> (-ag=<guid> | -an=<name>)

Description

Set SSH access credentials -n <NAME> (-ag <GUID> | -an <NAME>)-u <SSH_USER> -p <SSH_PASSWORD>

Options

-ag,app-guid=<guid> Application guid

-an,app-name=<name> Application name

-n, name=<name> Credentials name

-u, user=<user> SSH user

-p, password=<password> SSH password

vc-app-inst-mg-set-sshhost

Name

vc-app-inst-mg-set-sshhost - Set SSH access host/port (-ag | -an ) -h -p

Synopsis

vc app inst mg set sshhost -h=<host> -p=<port> (-ag=<guid> | -an=<name>)

Description

Set SSH access host/port (-ag <GUID> | -an <NAME>) -h <SSH_HOST> -p <SSH_PORT>

Options

-ag,app-guid=<guid> Application guid

-an,app-name=<name> Application name

-h, host**=<host>* SSH host

-p, port**=<port>* SSH port

vc-app-inst-mg-set-sshkey

Name

vc-app-inst-mg-set-sshkey - Set SSH key path (-ag | -an ) -p

Synopsis

vc app inst mg set sshkey -p=<keyPath> (-ag=<guid> | -an=<name>)

Description

Set SSH key path (-ag <GUID> | -an <NAME>) -p <SSH_KEYPATH>

Options

-ag,app-guid=<guid>

Application guid

-an,app-name=<name>

Application name

-p, path=<keyPath>

vc-app-inst-mg-update

Name

vc-app-inst-mg-update - Modify application (-ag | -an ) -n

Synopsis

vc app inst mg update -n=<name> (-ag=<guid> | -an=<name>)

Description

Modify application (-ag <GUID> | -an <NAME>) -n <NAME>

Options

-ag,app-guid=<guid>

Application guid

-an,app-name=<name>

Application name

-n, name=<name>

vc-app-inst-mg-updatevar

Name

vc-app-inst-mg-updatevar - Modify environment variable. Set variable hidden in UI: YES | NO -g (-ag | -an ) -n -v -h

Synopsis

vc app inst mg updatevar -g=<guid> -h=<hide> -n=<name> -v=<value> (-ag=<guid> | -an=<name>)

Description

Modify environment variable. Set variable hidden in UI: YES | NO -g <GUID> (-ag <GUID> | -an <NAME>) -n <NAME> -v <VALUE> -h <YES | NO>

Options

-ag,app-guid=<guid> Application guid

-an,app-name=<name> Application name

-g, guid=<guid> Environment Variable GUID

-n, name=<name> New variable name

-v, value**=<value>* New variable value

-h, hidden**=<hide>* Hidden in UI <YES | NO>

vc-bd

Name

vc-bd - BACKUP DESTINATION MANAGEMENT

Synopsis

vc bd [COMMAND]

Description

BACKUP DESTINATION MANAGEMENT

Commands

create

create recovery plan policies and rules

delete

Delete backup destination (-bg <GUID> | -bn <NAME>)

details

Backup destination details (-bg <GUID> | -bn <NAME>)

list

List of backup destinations

cloud

Backup destination for cloud (-bg <GUID> | -bn <NAME>) -a <YES or NO>

default

Set as default Set as default @|fg(226) (-bg <GUID> | -bn <NAME>) @

assign

Assign node configuration to backup destination (-bg <GUID> | -bn <NAME>) -nc <NC_GUID>,…​,<NC_GUID>

vc-bd-assign

Name

vc-bd-assign - Assign node configuration to backup destination (-bg | -bn ) -nc ,...,

Synopsis

vc bd assign -nc=<ncs>[,<ncs>…​] [-nc=<ncs>[,<ncs>…​]]…​ (-bg=<guid> | -bn=<name>)

Description

Assign node configuration to backup destination (-bg <GUID> | -bn <NAME>) -nc <NC_GUID>,…​,<NC_GUID>

Options

-bg,backup-destination-guid=<guid> Backup destination guid

-bn,backup-destination-name=<name> Backup destination name

-nc,node-config=<ncs>[,<ncs>…​] <NC_GUID>,…​,<NC_GUID> (no spaces)

vc-bd-cloud

Name

vc-bd-cloud - Backup destination for cloud (-bg | -bn ) -a

Synopsis

vc bd cloud -a=<active> (-bg=<guid> | -bn=<name>)

Description

Backup destination for cloud (-bg <GUID> | -bn <NAME>) -a <YES or NO>

Options

-a, active=<active> Set this backup destination for cloud: YES or NO

-bg,backup-destination-guid=<guid> Backup destination guid

-bn,backup-destination-name=<name> Backup destination name

vc-bd-create

Name

vc-bd-create - create recovery plan policies and rules

Synopsis

vc bd create [COMMAND]

Description

create recovery plan policies and rules

Commands

isp

Create new IBM Spectrum Protect backup destination -n <NAME>

openstack

Create new OpenStack Swift backup destination -n <NAME> -u <URL>

netbackup

Create new Veritas NetBackup backup destination -n <NAME> -p <POLICY> -s <SCHEDULE> -c <CLIENT_NAME>

networker

Create new Dell EMC NetWorker backup destination -n <NAME> -u <URL> -p <POOL_NAME> -c <CLIENT_NAME>

filesystem

Create new File system backup destination -n <NAME> -p <PATH>,…​,<PATH>

vstor

Create new Catalogic vStor Server backup destination -n <NAME> -p <PATH>,…​,<PATH>

xfs

Create new File System XFS (Synthetic) backup destination -n <NAME> -p <PATH>,…​,<PATH>

ddboost

Create new File System XFS (Synthetic) backup destination -n <NAME> -ps <PATH>,…​,<PATH>, -h <HOST> -u <UNIT_NAME>

-a <ACCOUNT_NAME> -p <PASSWORD>

amazon

Create new Amazon S3 / S3-compatible backup destination -n <NAME> -m <MODE>

-b <BUCKET_NAME>

azure

Create new Microsoft Azure backup destination -n <NAME> -m <MODE>

-a <ACCOUNT>

gcs

Create new Google Cloud Storage backup destination -n <NAME>

avamar

Create new Dell EMC Avamar backup destination -n <NAME>

dp

Create new Micro Focus Data Protector backup destination -n <NAME>

e

vc-bd-create-amazon

Name

vc-bd-create-amazon - Create new Amazon S3 / S3-compatible backup destination -n -m -b

Synopsis

vc bd create amazon [-b=<bucketName>] [-m=<mode>] -n=<name>

Description

Create new Amazon S3 / S3-compatible backup destination -n <NAME> -m <MODE> -b <BUCKET_NAME>

Options

-b, bucket-name**=<bucketName>* Bucket name

-m, mode**=<mode>* Mode that specifies if backups should be stored in one bucket or in separate buckets for each Virtual Environment

Modes: ONE_BUCKET_PER_VM, SINGLE_BUCKET, NO_VERSIONING_SINGLE_BUCKET

-n, name=<name> Backup destination name

vc-bd-create-avamar

Name

vc-bd-create-avamar - Create new Dell EMC Avamar backup destination -n

Synopsis

vc bd create avamar -a=<accountName> -n=<name> -p=<path>

Description

Create new Dell EMC Avamar backup destination -n <NAME>

Options

-a, account**=<accountName>* Account data in form of domain/clientName, i.e. clients/avamar-client.vplus.local

-n, name=<name> Backup destination name

-p, path=<path> MCCLI binary path

vc-bd-create-azure

Name

vc-bd-create-azure - Create new Microsoft Azure backup destination -n -m -a

Synopsis

vc bd create azure -a=<accountName> [-m=<mode>] -n=<name>

Description

Create new Microsoft Azure backup destination -n <NAME> -m <MODE> -a <ACCOUNT>

Options

-a, account**=<accountName>* Account name: tenant name used by vPlus to log into Microsoft Azure

-m, mode**=<mode>* Mode that specifies if backups should be stored in one bucket or in separate buckets for each Virtual Environment

Modes: ONE_BUCKET_PER_VM, SINGLE_BUCKET

-n, name=<name> Backup destination name

vc-bd-create-ddboost

Name

vc-bd-create-ddboost - Create new File System XFS (Synthetic) backup destination -n -ps ,...,, -h -u -a -p

Synopsis

vc bd create ddboost -a=<accountName> -h=<host> -n=<name> -p=<password> -u=<unitName> -ps=<path>[,<path>…​] [-ps=<path>[, <path>…​]]…​

Description

Create new File System XFS (Synthetic) backup destination -n <NAME> -ps <PATH>,…​,<PATH>, -h <HOST> -u <UNIT_NAME> -a <ACCOUNT_NAME> -p <PASSWORD>

Options

-a, a**=<accountName>* Account name

-h, host**=<host>_ -n, name=_<name>* Backup destination name

-p, password=<password> Password

-ps,paths=<path>[,<path>…​] List of paths accessible from the node where backups should be stored, <PATH>,…​,<PATH> (no spaces)

-u, unit-name**=<unitName>* Storage Unit Name

vc-bd-create-dp

Name

vc-bd-create-dp - Create new Micro Focus Data Protector backup destination -n

Synopsis

vc bd create dp -n=<name>

Description

Create new Micro Focus Data Protector backup destination -n <NAME>

Options

-n, name=<name> Backup destination name

vc-bd-create-filesystem

Name

vc-bd-create-filesystem - Create new File system backup destination -n -p ,...,

Synopsis

vc bd create filesystem -n=<name> -p=<path>[,<path>…​] [-p=<path>[, <path>…​]]…​

Description

Create new File system backup destination -n <NAME> -p <PATH>,…​,<PATH>

Options

-n, name=<name> Backup destination name

-p, path=<path>[,<path>…​] List of paths accessible from the node where backups should be stored, <PATH>,…​,<PATH> (no spaces)

vc-bd-create-gcs

Name

vc-bd-create-gcs - Create new Google Cloud Storage backup destination -n

Synopsis

vc bd create gcs -n=<name>

Description

Create new Google Cloud Storage backup destination -n <NAME>

Options

-n, name=<name> Backup destination name

vc-bd-create-isp

Name

vc-bd-create-isp - Create new IBM Spectrum Protect backup destination -n

Synopsis

vc bd create isp <name>

Description

Create new IBM Spectrum Protect backup destination -n <NAME>

Arguments

<name> Backup destination name

vc-bd-create-netbackup

Name

vc-bd-create-netbackup - Create new Veritas NetBackup backup destination -n -p -s -c

Synopsis

vc bd create netbackup -c=<clientName> -n=<name> -p=<policy> -s=<schedule>

Description

Create new Veritas NetBackup backup destination -n <NAME> -p <POLICY> -s <SCHEDULE> -c <CLIENT_NAME>

Options

-c, client-name=<clientName> Name of the client that owns backups - create separate backup destinations for each vPlus Node that interacts with NetBackup

-n, name=<name> Backup destination name

-p, policy**=<policy>* Policy name assigned in NetBackup to the client used by vPlus

-s, schedule**=<schedule>* Name of the schedule assigned in NetBackup to the client used by vPlus backup schedules are controlled by vPlus, so no specific values should be configured in NetBackup

vc-bd-create-networker

Name

vc-bd-create-networker - Create new Dell EMC NetWorker backup destination -n -u -p -c

Synopsis

vc bd create networker -c=<clientName> -n=<name> -p=<poolName> -u=<path>

Description

Create new Dell EMC NetWorker backup destination -n <NAME> -u <URL> -p <POOL_NAME> -c <CLIENT_NAME>

Options

-c, client-name=<clientName> Name of the client that owns backups - create separate backup destinations for each vPlus Node that interacts with NetBackup

-n, name=<name> Backup destination name

-p, pool-name=<poolName> Pool name

-u, url=<path> Address of your Networker server

vc-bd-create-openstack

Name

vc-bd-create-openstack - Create new OpenStack Swift backup destination -n -u

Synopsis

vc bd create openstack -n=<name> -u=<path>

Description

Create new OpenStack Swift backup destination -n <NAME> -u <URL>

Options

-n, name=<name> Backup destination name

-u, url=<path> v2 URL pointing to authentication service

vc-bd-create-vstor

Name

vc-bd-create-vstor - Create new Catalogic vStor Server backup destination -n -p ,...,

Synopsis

vc bd create vstor -n=<name> -p=<path>[,<path>…​] [-p=<path>[,<path>…​]]…​

Description

Create new Catalogic vStor Server backup destination -n <NAME> -p <PATH>,…​,<PATH>

Options

-n, name=<name> Backup destination name

-p, path=<path>[,<path>…​] List of paths accessible from the node where backups should be stored, <PATH>,…​,<PATH> (no spaces)

vc-bd-create-xfs

Name

vc-bd-create-xfs - Create new File System XFS (Synthetic) backup destination -n -p ,...,

Synopsis

vc bd create xfs -n=<name> -p=<path>[,<path>…​] [-p=<path>[,<path>…​]]…​

Description

Create new File System XFS (Synthetic) backup destination -n <NAME> -p <PATH>,…​,<PATH>

Options

-n, name=<name> Backup destination name

-p, paths**=<path>[,<path>*…​] List of paths accessible from the node where backups should be stored, <PATH>,…​,<PATH> (no spaces)

vc-bd-default

Name

vc-bd-default - Set as default Set as default @|fg(226) (-bg | -bn ) @

Synopsis

vc bd default (-bg=<guid> | -bn=<name>)

Description

Set as default Set as default @|fg(226) (-bg <GUID> | -bn <NAME>) @

Options

-bg,backup-destination-guid=<guid> Backup destination guid

-bn,backup-destination-name=<name> Backup destination name

vc-bd-delete

Name

vc-bd-delete - Delete backup destination (-bg | -bn )

Synopsis

vc bd delete (-bg=<guid> | -bn=<name>)

Description

Delete backup destination (-bg <GUID> | -bn <NAME>)

Options

-bg,backup-destination-guid=<guid> Backup destination guid

-bn,backup-destination-name=<name> Backup destination name

vc-bd-details

Name

vc-bd-details - Backup destination details (-bg | -bn )

Synopsis

vc bd details (-bg=<guid> | -bn=<name>)

Description

Backup destination details (-bg <GUID> | -bn <NAME>)

Options

-bg,backup-destination-guid=<guid> Backup destination guid

-bn,backup-destination-name=<name> Backup destination name

vc-bd-list

Name

vc-bd-list - List of backup destinations

Synopsis

vc bd list [-h=<noHeaders>]

Description

List of backup destinations

Options

-h, no-headers=<noHeaders>

vc-cloud

Name

vc-cloud - CLOUD MANAGEMENT

Synopsis

vc cloud [COMMAND]

Description

CLOUD MANAGEMENT

Commands

inst

Cloud instances

provider

Service Provider instances

backup

Backup SLA

download

Download

vc-cloud-backup

Name

vc-cloud-backup - Backup SLA

Synopsis

vc cloud backup [COMMAND]

Description

Backup SLA

Commands

policy

policy

schedule

Schedule instances

vc-cloud-backup-policy

Name

vc-cloud-backup-policy - policy

Synopsis

vc cloud backup policy [COMMAND]

Description

policy

Commands

create

Create a new policy <NAME>

delete

Delete policy <GUID>

details

Show details <GUID>

update

Modify policy name -g <GUID> -n <NAME>

include

Set policy include deleted items -g <GUID> -i <YES | NO>

fail

Fails rest of the backup tasks

set

Set recovery plan policies and rules

list

Lists recovery plan policies and rules

inc

Run incremental backup for selected policy

full

Run full backup for selected policy

vc-cloud-backup-policy-create

Name

vc-cloud-backup-policy-create - Create a new policy

Synopsis

vc cloud backup policy create <name>

Description

Create a new policy <NAME>

Arguments

<name>

vc-cloud-backup-policy-delete

Name

vc-cloud-backup-policy-delete - Delete policy

Synopsis

vc cloud backup policy delete <guid>

Description

Delete policy <GUID>

Arguments

<guid>

vc-cloud-backup-policy-details

Name

vc-cloud-backup-policy-details - Show details

Synopsis

vc cloud backup policy details <guid>

Description

Show details <GUID>

Arguments

<guid>

vc-cloud-backup-policy-fail

Name

vc-cloud-backup-policy-fail - Fails rest of the backup tasks

Synopsis

vc cloud backup policy fail -a=<active> -p=<percent> -t=<exportOrStore> (-pg=<guid> | -pn=<name>)

Description

Fails rest of the backup tasks

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-t, type**=<exportOrStore>* Type: STORE, EXPORT

-a, active=<active> Active fail rest of the backup (YES or NO)

-p, percent**=<percent>* Percent of already failed tasks

vc-cloud-backup-policy-full

Name

vc-cloud-backup-policy-full - Run full backup for selected policy

Synopsis

vc cloud backup policy full -g=<guid> -p=<priority> -r=<retryCount> -e=<entities>[,<entities>…​] [-e=<entities>[, <entities>…​]]…​

Description

Run full backup for selected policy

Options

-g, guid=<guid> Policy GUID

-p, priority**=<priority>* Priority: 0-100, default: 50

-r, retry-count**=<retryCount>* -e, *entity*=<entities>[,<entities>*…​] <ENTITY_GUID>,…​,<ENTITY_GUID> (no spaces)

vc-cloud-backup-policy-include

Name

vc-cloud-backup-policy-include - Set policy include deleted items -g -i

Synopsis

vc cloud backup policy include -g=<guid> -i=<include>

Description

Set policy include deleted items -g <GUID> -i <YES | NO>

Options

-g, guid=<guid> -i, include**=<include>* Include folder to the backup (YES or NO)

vc-cloud-backup-policy-inc

Name

vc-cloud-backup-policy-inc - Run incremental backup for selected policy

Synopsis

vc cloud backup policy inc -g=<guid> -p=<priority> -r=<retryCount>

Description

Run incremental backup for selected policy

Options

-g, guid=<guid>

Policy GUID

-p, priority**=<priority>*

Priority: 0-100, default: 50

-r, retry-count**=<retryCount>*

vc-cloud-backup-policy-list-features

Name

vc-cloud-backup-policy-list-features - List policy features

Synopsis

vc cloud backup policy list features <guid>

Description

List policy features <GUID>

Arguments

<guid>

vc-cloud-backup-policy-list

Name

vc-cloud-backup-policy-list - Lists recovery plan policies and rules

Synopsis

vc cloud backup policy list [COMMAND]

Description

Lists recovery plan policies and rules

Commands

policy

List backup policies

schedule

List schedules for the policy <GUID>

rule

List rules for cloud backup policy -g <GUID>

features

List policy features <GUID>

vc-cloud-backup-policy-list-policy

Name

vc-cloud-backup-policy-list-policy - List backup policies

Synopsis

vc cloud backup policy list policy [-h=<noHeaders>]

Description

List backup policies

Options

-h, no-headers=<noHeaders>

vc-cloud-backup-policy-list-rule

Name

vc-cloud-backup-policy-list-rule - List rules for cloud backup policy -g

Synopsis

vc cloud backup policy list rule [-g=<guid>] [-h=<noHeaders>]

Description

List rules for cloud backup policy -g <GUID>

Options

-g, guid=<guid>

Policy guid

-h, no-headers=<noHeaders>

vc-cloud-backup-policy-list-schedule

Name

vc-cloud-backup-policy-list-schedule - List schedules for the policy

Synopsis

vc cloud backup policy list schedule [-g=<guid>] [-h=<noHeaders>]

Description

List schedules for the policy <GUID>

Options

-g, guid=<guid>

Policy guid

-h, no-headers=<noHeaders>

vc-cloud-backup-policy-set-activation

Name

vc-cloud-backup-policy-set-activation - Set policy activation state -g -a

Synopsis

vc cloud backup policy set activation -a=<active> -g=<guid>

Description

Set policy activation state -g <GUID> -a <YES | NO>

Options

-g, guid=<guid> -a, active=<active> YES or NO

vc-cloud-backup-policy-set-feature

Name

vc-cloud-backup-policy-set-feature - Set features for the policy -g -f ,...,

Synopsis

vc cloud backup policy set feature -g=<guid> -f=<feature>[,<feature>…​] [-f=<feature>[,<feature>…​]]…​

Description

Set features for the policy -g <POLICY_GUID> -f <FEATURE>,…​,<FEATURE>

Options

-g, guid=<guid> -f, feature**=<feature>[,<feature>*…​] <FEATURE>,…​,<FEATURE> (no spaces)

vc-cloud-backup-policy-set

Name

vc-cloud-backup-policy-set - Set recovery plan policies and rules

Synopsis

vc cloud backup policy set [COMMAND]

Description

Set recovery plan policies and rules

Commands

activation

Set policy activation state -g <GUID> -a <YES | NO>

priority

Set policy’s backup task priority -g <GUID> -p <PRIORITY>

mode

Set auto-assignment mode -g <GUID> -m <MODE>

retry

Set backup policy retry count -g <GUID> -c <COUNT>

feature

Set features for the policy -g <POLICY_GUID> -f <FEATURE>,…​,<FEATURE>

provider

Set service provider to auto-assignment

vc-cloud-backup-policy-set-mode

Name

vc-cloud-backup-policy-set-mode - Set auto-assignment mode -g -m

Synopsis

vc cloud backup policy set mode -g=<guid> -m=<mode>

Description

Set auto-assignment mode -g <GUID> -m <MODE>

Options

-g, guid=<guid> -m, mode**=<mode>* Active auto-assign (YES or NO)

vc-cloud-backup-policy-set-priority

Name

vc-cloud-backup-policy-set-priority - Set policy's backup task priority -g -p

Synopsis

vc cloud backup policy set priority -g=<guid> -p=<priority>

Description

Set policy’s backup task priority -g <GUID> -p <PRIORITY>

Options

-g, guid=<guid> -p, priority**=<priority>* Range: 0-100 (50 default)

vc-cloud-backup-policy-set-provider

Name

vc-cloud-backup-policy-set-provider - Set service provider to auto-assignment

Synopsis

vc cloud backup policy set provider -g=<guid> -p=<serviceProviderGuid>

Description

Set service provider to auto-assignment

Options

-g, guid=<guid> Policy GUID

-p, service-provider**=<serviceProviderGuid>* Service Provider GUID

vc-cloud-backup-policy-set-retry

Name

vc-cloud-backup-policy-set-retry - Set backup policy retry count -g -c

Synopsis

vc cloud backup policy set retry -c=<count> -g=<guid>

Description

Set backup policy retry count -g <GUID> -c <COUNT>

Options

-g, guid=<guid>

-c, count**=<count>*

vc-cloud-backup-policy-update

Name

vc-cloud-backup-policy-update - Modify policy name -g -n

Synopsis

vc cloud backup policy update -g=<guid> -n=<name>

Description

Modify policy name -g <GUID> -n <NAME>

Options

-g, guid=<guid>

-n, name=<name>

vc-cloud-backup-schedule

Name

vc-cloud-backup-schedule - Schedule instances

Synopsis

vc cloud backup schedule [COMMAND]

Description

Schedule instances

Commands

list

List cloud 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

policy

Add policy

vc-cloud-backup-schedule-active

Name

vc-cloud-backup-schedule-active - Set schedule to be active (YES or NO) -g -a

Synopsis

vc cloud 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

vc-cloud-backup-schedule-create

Name

vc-cloud-backup-schedule-create - Create new schedule

Synopsis

vc cloud 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

vc-cloud-backup-schedule-delete

Name

vc-cloud-backup-schedule-delete - Delete schedule

Synopsis

vc cloud backup schedule delete (-sg=<scheduleGuid> | -sn=<scheduleName>)

Description

Delete schedule <GUID>

Options

-sg,schedule-guid=<scheduleGuid> Cloud backup schedule guid

-sn,schedule-name=<scheduleName> Cloud backup schedule name

vc-cloud-backup-schedule-details

Name

vc-cloud-backup-schedule-details - Show schedule details

Synopsis

vc cloud backup schedule details <guid>

Description

Show schedule details <GUID>

Arguments

<guid>

vc-cloud-backup-schedule-list

Name

vc-cloud-backup-schedule-list - List cloud schedules

Synopsis

vc cloud backup schedule list [-h=<noHeaders>]

Description

List cloud schedules

Options

-h, no-headers=<noHeaders>

vc-cloud-backup-schedule-policy

Name

vc-cloud-backup-schedule-policy - Add policy

Synopsis

vc cloud backup schedule policy (-s=<guid> | -sn=<name>) (-p=<guid> | -pn=<name>)

Description

Add policy

Options

-s, sched-guid=<guid> Schedule guid

-sn,sched-name=<name> Schedule name

-p, policy-guid=<guid> Policy guid

-pn,policy-name=<name> Policy name

vc-cloud-backup-schedule-update

Name

vc-cloud-backup-schedule-update - Update schedule

Synopsis

vc cloud backup schedule update -b=<backupType> -d=<duration> -g=<guid> -n=<name> -se=<scheduleExecutionType> -t=<time> -dw=<daysOfWeek> [-dw=<daysOfWeek>]…​ -m=<months> [-m=<months>]…​ -o=<occurrence> [-o=<occurrence>]…​

Description

Update schedule

Options

-g, guid=<guid> -n, name=<name> -b, backup-type=<backupType> Types: FULL, INCREMENTAL, SYNTHETIC, SYNCHRONIZATION

-se,exec-type=<scheduleExecutionType> Schedule exec type. Types: TIME, INTERVAL

-t, time=<time> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR>

-d, duration=<duration> <DURATION | INTERVAL_FREQUENCY>

-dw,days-of-week=<daysOfWeek> <EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY>

-o, occurrence=<occurrence> <ANY, FIRST_IN_MONTH, SECOND_IN_MONTH, THIRD_IN_MONTH, FOURTH_IN_MONTH, LAST_IN_MONTH>

-m, months=<months> <ANY, JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER>

vc-cloud-download

Name

vc-cloud-download - Download

Synopsis

vc cloud download [COMMAND]

Description

Download

Commands

list

List cloud service providers

app

Add application for cloud service provider

details

Cloud service provider details

delete

Delete cloud service provider

create

Create a new cloud service provider

sync

Synchronize inventory with Storage Provider <GUID>

vc-cloud-download-app

Name

vc-cloud-download-app - Add application for cloud service provider

Synopsis

vc cloud download app -g=<guid> -p=<password> -u=<user>

Description

Add application for cloud service provider

Options

-g, guid=<guid> Service Provider GUID

-u, user=<user> Client ID

-p, password=<password> Client secret

vc-cloud-download-create

Name

vc-cloud-download-create - Create a new cloud service provider

Synopsis

vc cloud download create -n=<name> -nc=<nodeConf> -t=<tenantID>

Description

Create a new cloud service provider

Options

-n, name=<name> -t, tenant**=<tenantID>* Tenant ID

-nc,node-conf=<nodeConf> Node configuration GUID or DEFAULT to set default node config for provider

vc-cloud-download-delete

Name

vc-cloud-download-delete - Delete cloud service provider

Synopsis

vc cloud download delete <guid>

Description

Delete cloud service provider

Arguments

<guid>

vc-cloud-download-details

Name

vc-cloud-download-details - Cloud service provider details

Synopsis

vc cloud download details <guid>

Description

Cloud service provider details

Arguments

<guid>

vc-cloud-download-list

Name

vc-cloud-download-list - List cloud service providers

Synopsis

vc cloud download list [-h=<noHeaders>]

Description

List cloud service providers

Options

-h, no-headers=<noHeaders>

vc-cloud-download-sync

Name

vc-cloud-download-sync - Synchronize inventory with Storage Provider

Synopsis

vc cloud download sync <guid>

Description

Synchronize inventory with Storage Provider <GUID>

Arguments

<guid>

vc-cloud-inst

Name

vc-cloud-inst - Cloud instances

Synopsis

vc cloud inst [COMMAND]

Description

Cloud instances

Commands

list

Cloud instances instances

user

Cloud instances instances

team

Cloud instances instances

site

Cloud instances instances

group

Cloud instances instances

vc-cloud-inst-group-backup

Name

vc-cloud-inst-group-backup - Run single group backup for features selected in policy -g -p -r

Synopsis

vc cloud inst group backup -g=<guid> [-p=<priority>] -r=<retryCount>

Description

Run single group backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

Options

-g, guid=<guid>

User GUID

-p, priority**=<priority>*

Priority: 0-100, default: 50

-r, retry-count**=<retryCount>*

vc-cloud-inst-group

Name

vc-cloud-inst-group - Cloud instances instances

Synopsis

vc cloud inst group [COMMAND]

Description

Cloud instances instances

Commands

backup

Run single group backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

vc-cloud-inst-list

Name

vc-cloud-inst-list - Cloud instances instances

Synopsis

vc cloud inst list [COMMAND]

Description

Cloud instances instances

Commands

users

Cloud users list

sites

Cloud sites list

teams

Cloud teams list

vc-cloud-inst-list-sites

Name

vc-cloud-inst-list-sites - Cloud sites list

Synopsis

vc cloud inst list sites [-h=<noHeaders>]

Description

Cloud sites list

Options

-h, no-headers=<noHeaders>

vc-cloud-inst-list-teams

Name

vc-cloud-inst-list-teams - Cloud teams list

Synopsis

vc cloud inst list teams [-h=<noHeaders>]

Description

Cloud teams list

Options

-h, no-headers=<noHeaders>

vc-cloud-inst-list-users

Name

vc-cloud-inst-list-users - Cloud users list

Synopsis

vc cloud inst list users [-h=<noHeaders>]

Description

Cloud users list

Options

-h, no-headers=<noHeaders>

vc-cloud-inst-site-backup

Name

vc-cloud-inst-site-backup - Run single user backup for features selected in policy -g -p -r

Synopsis

vc cloud inst site backup -g=<guid> [-p=<priority>] -r=<retryCount>

Description

Run single user backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

Options

-g, guid=<guid>

User GUID

-p, priority**=<priority>*

Priority: 0-100, default: 50

-r, retry-count**=<retryCount>*

vc-cloud-inst-site

Name

vc-cloud-inst-site - Cloud instances instances

Synopsis

vc cloud inst site [COMMAND]

Description

Cloud instances instances

Commands

backup

Run single user backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

vc-cloud-inst-team-backup

Name

vc-cloud-inst-team-backup - Run single user backup for features selected in policy -g -p -r

Synopsis

vc cloud inst team backup -g=<guid> [-p=<priority>] -r=<retryCount>

Description

Run single user backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

Options

-g, guid=<guid>

User GUID

-p, priority**=<priority>*

Priority: 0-100, default: 50

-r, retry-count**=<retryCount>*

vc-cloud-inst-team

Name

vc-cloud-inst-team - Cloud instances instances

Synopsis

vc cloud inst team [COMMAND]

Description

Cloud instances instances

Commands

backup

Run single user backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

vc-cloud-inst-user-backup

Name

vc-cloud-inst-user-backup - Run single user backup for features selected in policy -g -p -r

Synopsis

vc cloud inst user backup -g=<guid> [-p=<priority>] -r=<retryCount>

Description

Run single user backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

Options

-g, guid=<guid>

User GUID

-p, priority**=<priority>*

Priority: 0-100, default: 50

-r, retry-count**=<retryCount>*

vc-cloud-inst-user

Name

vc-cloud-inst-user - Cloud instances instances

Synopsis

vc cloud inst user [COMMAND]

Description

Cloud instances instances

Commands

backup

Run single user backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

restore

Run single user backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

vc-cloud-inst-user-restore

Name

vc-cloud-inst-user-restore - Run single user backup for features selected in policy -g -p -r

Synopsis

vc cloud inst user restore -g=<guid> [-p=<priority>] [-r=<retryCount>]

Description

Run single user backup for features selected in policy -g <USER_GUID> -p <PRIORITY> -r <RETRY_COUNT>

Options

-g, guid=<guid>

User GUID

-p, priority**=<priority>*

Priority: 0-100, default: 50

-r, retry-count**=<retryCount>*

vc-cloud-provider

Name

vc-cloud-provider - Service Provider instances

Synopsis

vc cloud provider [COMMAND]

Description

Service Provider instances

Commands

list

List cloud service providers

app

Add application for cloud service provider

details

Cloud service provider details

delete

Delete cloud service provider

create

Create a new cloud service provider

sync

Synchronize inventory with Storage Provider <GUID>

vc-cloud-provider-app

Name

vc-cloud-provider-app - Add application for cloud service provider

Synopsis

vc cloud provider app -g=<guid> -p=<password> -u=<user>

Description

Add application for cloud service provider

Options

-g, guid=<guid> Service Provider GUID

-u, user=<user> Client ID

-p, password=<password> Client secret

vc-cloud-provider-create

Name

vc-cloud-provider-create - Create a new cloud service provider

Synopsis

vc cloud provider create -n=<name> -nc=<nodeConf> -t=<tenantID>

Description

Create a new cloud service provider

Options

-n, name=<name> -t, tenant**=<tenantID>* Tenant ID

-nc,node-conf=<nodeConf> Node configuration GUID or DEFAULT to set default node config for provider

vc-cloud-provider-delete

Name

vc-cloud-provider-delete - Delete cloud service provider

Synopsis

vc cloud provider delete <guid>

Description

Delete cloud service provider

Arguments

<guid>

vc-cloud-provider-details

Name

vc-cloud-provider-details - Cloud service provider details

Synopsis

vc cloud provider details <guid>

Description

Cloud service provider details

Arguments

<guid>

vc-cloud-provider-list

Name

vc-cloud-provider-list - List cloud service providers

Synopsis

vc cloud provider list [-h=<noHeaders>]

Description

List cloud service providers

Options

-h, no-headers=<noHeaders>

vc-cloud-provider-sync

Name

vc-cloud-provider-sync - Synchronize inventory with Storage Provider

Synopsis

vc cloud provider sync <guid>

Description

Synchronize inventory with Storage Provider <GUID>

Arguments

<guid>

vc-node

Name

vc-node - NODES MANAGEMENT

Synopsis

vc node [COMMAND]

Description

NODES MANAGEMENT

Commands

inst

Node instances

config

Node configurations

vc-node-config-add

Name

vc-node-config-add - Add backup destinations ( -ncg | -ncn ) -b ,...,

Synopsis

vc node config add -b=<bdNames> [-b=<bdNames>]…​ (-ncg=<guid> | -ncn=<name>)

Description

Add backup destinations ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> ) -b <BD_NAME | BD_GUID>,…​,<BD_NAME | BD_GUID>

Options

-b, bdname**=<bdNames>* <BD_GUID>,…​,<BD_GUID> (no spaces)

-ncg,node-config-guid=<guid> Node config guid

-ncn,node-config-name=<name> Node config name

vc-node-config-create

Name

vc-node-config-create - Create new node configuration

Synopsis

vc node config create <name>

Description

Create new node configuration <NAME>

Arguments

<name>

vc-node-config-delete

Name

vc-node-config-delete - Delete node configuration ( -ncg | -ncn )

Synopsis

vc node config delete (-ncg=<guid> | -ncn=<name>)

Description

Delete node configuration ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> )

Options

-ncg,node-config-guid=<guid> Node config guid

-ncn,node-config-name=<name> Node config name

vc-node-config-details

Name

vc-node-config-details - node details ( -ncg | -ncn )

Synopsis

vc node config details (-ncg=<guid> | -ncn=<name>)

Description

node details ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> )

Options

-ncg,node-config-guid=<guid> Node config guid

-ncn,node-config-name=<name> Node config name

vc-node-config-list

Name

vc-node-config-list - List of node configurations

Synopsis

vc node config list

Description

List of node configurations

vc-node-config

Name

vc-node-config - Node configurations

Synopsis

vc node config [COMMAND]

Description

Node configurations

Commands

delete

Delete node configuration ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> )

list

List of node configurations

details

node details ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> )

create

Create new node configuration <NAME>

add

Add backup destinations ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> ) -b <BD_NAME | BD_GUID>,…​,<BD_NAME | BD_GUID>

remove

Remove backup destination ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> ) -n <BD_NAME | BD_GUID>

set

Modify node configuration ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> ) -p <PROPERTY NUMBER> -v <NEW VALUE>

vc-node-config-remove

Name

vc-node-config-remove - Remove backup destination ( -ncg | -ncn ) -n

Synopsis

vc node config remove -n=<name> [-n=<name>]…​ (-ncg=<guid> | -ncn=<name>)

Description

Remove backup destination ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> ) -n <BD_NAME | BD_GUID>

Options

-n, name=<name> Backup destination name or GUID

-ncg,node-config-guid=<guid> Node config guid

-ncn,node-config-name=<name> Node config name

vc-node-config-set

Name

vc-node-config-set - Modify node configuration ( -ncg | -ncn ) -p -v

Synopsis

vc node config set -p=<propertyNumber> -v=<value> (-ncg=<guid> | -ncn=<name>)

Description

Modify node configuration ( -ncg <CONFIG_GUID> | -ncn <CONFIG_NAME> ) -p <PROPERTY NUMBER> -v <NEW VALUE>

Options

-ncg,node-config-guid=<guid> Node config guid

-ncn,node-config-name=<name> Node config name

-p, property-number**=<propertyNumber>* Node configuration property number

-v, value**=<value>* Value to set

vc-node-inst-delete

Name

vc-node-inst-delete - Delete node -ng | -nn

Synopsis

vc node inst delete (-ng=<guid> | -nn=<name>)

Description

Delete node -ng <NODE_GUID> | -nn <NODE_NAME>

Options

-ng,node-guid=<guid> Node guid

-nn,node-name=<name> Node name

vc-node-inst-list

Name

vc-node-inst-list - Nodes list

Synopsis

vc node inst list [-h=<noHeaders>]

Description

Nodes list

Options

-h, no-headers=<noHeaders>

vc-node-inst

Name

vc-node-inst - Node instances

Synopsis

vc node inst [COMMAND]

Description

Node instances

Commands

delete

Delete node -ng <NODE_GUID> | -nn <NODE_NAME>

list

Nodes list

register

Register node -n <NODE NAME> -i <API URL> -u <USER> -p <PASSWORD>

update

Update existing node -n <NODE_NAME> -i <API_URL> -u <USER> -p <PASSWORD>

nc

Set node configuration (-ng <NODE_GUID> | -nn <NODE_NAME> ) -g <NODE_CONFIG_GUID>

vc-node-inst-nc

Name

vc-node-inst-nc - Set node configuration (-ng | -nn ) -g

Synopsis

vc node inst nc -nc=<nodeConfGuid> (-ng=<guid> | -nn=<name>)

Description

Set node configuration (-ng <NODE_GUID> | -nn <NODE_NAME> ) -g <NODE_CONFIG_GUID>

Options

-ng,node-guid=<guid> Node guid

-nn,node-name=<name> Node name

-nc,node-config=<nodeConfGuid> Node configuration GUID

vc-node-inst-register

Name

vc-node-inst-register - Register node -n -i -u -p

Synopsis

vc node inst register -i=<apiurl> -n=<name> -p=<password> -u=<login>

Description

Register node -n <NODE NAME> -i <API URL> -u <USER> -p <PASSWORD>

Options

-n, name=<name>

-i, apiurl**=<apiurl>*

-u, login=<login>

-p, password=<password>

vc-node-inst-update

Name

vc-node-inst-update - Update existing node -n -i -u -p

Synopsis

vc node inst update -i=<apiURL> -n=<nodeName> -p=<password> -u=<login>

Description

Update existing node -n <NODE_NAME> -i <API_URL> -u <USER> -p <PASSWORD>

Options

-i, apiurl**=<apiURL>*

-n, name=<nodeName>

-p, password=<password>

-u, login=<login>

vc-storage

Name

vc-storage - STORAGE MANAGEMENT

Synopsis

vc storage [COMMAND]

Description

STORAGE MANAGEMENT

Commands

inst

Storage instances

inf

Storage infrastructure

backup

Backup SLA

snapshot

Snapshot SLA

mounted

Mounted backups

vc-storage-backup

Name

vc-storage-backup - Backup SLA

Synopsis

vc storage backup [COMMAND]

Description

Backup SLA

Commands

policy

Backup SLA

schedule

Backup policy schedules

vc-storage-backup-policy-addrule

Name

vc-storage-backup-policy-addrule - Add new rule to selected policy

Synopsis

vc storage backup policy addrule -b=<bd> -k=<keep> -n=<name> -rf=<fulldays> -ri=<incdays> -s=<schedule> -vf=<fullversion> -vi=<incversion> (-pg=<guid> | -pn=<name>)

Description

Add new rule to selected policy

Options

-n, name=<name> -pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-s, schedule**=<schedule>* Schedule GUID

-b, back-dest**=<bd>* 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)

vc-storage-backup-policy-addtag

Name

vc-storage-backup-policy-addtag - Add auto-assignment tag (-pg | -pn ) -t -a

Synopsis

vc storage backup policy addtag -a=<tag> -t=<type> (-pg=<guid> | -pn=<name>)

Description

Add auto-assignment tag (-pg <GUID> | -pn <NAME>) -t <TYPE> -a <TAG>

Options

-pg,policy-guid=<guid>

Backup policy guid

-pn,policy-name=<name>

Backup policy name

-t, type**=<type>*

Types: INCLUDE, EXCLUDE

-a, tag**=<tag>*

vc-storage-backup-policy-create

Name

vc-storage-backup-policy-create - Create a new policy

Synopsis

vc storage backup policy create <name>

Description

Create a new policy <NAME>

Arguments

<name>

vc-storage-backup-policy-delete

Name

vc-storage-backup-policy-delete - Delete policy (-pg | -pn )

Synopsis

vc storage backup policy delete (-pg=<guid> | -pn=<name>)

Description

Delete policy (-pg <GUID> | -pn <NAME>)

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

vc-storage-backup-policy-details

Name

vc-storage-backup-policy-details - Show details (-pg | -pn )

Synopsis

vc storage backup policy details (-pg=<guid> | -pn=<name>)

Description

Show details (-pg <GUID> | -pn <NAME>)

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

vc-storage-backup-policy-fail

Name

vc-storage-backup-policy-fail - Fails rest of the backup tasks

Synopsis

vc storage backup policy fail -a=<active> -p=<percent> -t=<exportOrStore> (-pg=<guid> | -pn=<name>)

Description

Fails rest of the backup tasks

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-t, type**=<exportOrStore>* Type: STORE, EXPORT

-a, active=<active> Active fail rest of the backup (YES or NO)

-p, percent**=<percent>* Percent of already failed tasks

vc-storage-backup-policy-full

Name

vc-storage-backup-policy-full - Run full backup for selected policy

Synopsis

vc storage backup policy full -p=<priority> -r=<retryCount> -s=<storages>[, <storages>…​] [-s=<storages>[,<storages>…​]]…​ (-pg=<guid> | -pn=<name>)

Description

Run full backup for selected policy

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-p, priority**=<priority>* Priority: 0-100, default: 50

-r, retry-count**=<retryCount>* -s, *storage*=<storages>[,<storages>*…​] <STORAGE_GUID>,…​,<STORAGE_GUID> (no spaces)

vc-storage-backup-policy-inc

Name

vc-storage-backup-policy-inc - Run incremental backup for selected policy

Synopsis

vc storage backup policy inc -p=<priority> -r=<retryCount> -s=<storages>[, <storages>…​] [-s=<storages>[,<storages>…​]]…​ (-pg=<guid> | -pn=<name>)

Description

Run incremental backup for selected policy

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-p, priority**=<priority>* Priority: 0-100, default: 50

-r, retry-count**=<retryCount>* -s, *storages*=<storages>[,<storages>*…​] <STORAGE_GUID>,…​,<STORAGE_GUID> (no spaces)

vc-storage-backup-policy-list

Name

vc-storage-backup-policy-list - Lists recovery plan policies and rules

Synopsis

vc storage backup policy list [COMMAND]

Description

Lists recovery plan policies and rules

Commands

policies

List policies

rule

List rules for storage backup policy (-pg <GUID> | -pn <NAME>)

storage

List storages assigned to a policy (-pg <GUID> | -pn <NAME>)

schedule

List schedules for the policy (-pg <GUID> | -pn <NAME>)

vc-storage-backup-policy-list-policies

Name

vc-storage-backup-policy-list-policies - List policies

Synopsis

vc storage backup policy list policies [-h=<noHeaders>]

Description

List policies

Options

-h, no-headers=<noHeaders>

vc-storage-backup-policy-list-rule

Name

vc-storage-backup-policy-list-rule - List rules for storage backup policy (-pg | -pn )

Synopsis

vc storage backup policy list rule [-h=<noHeaders>] (-pg=<guid> | -pn=<name>)

Description

List rules for storage backup policy (-pg <GUID> | -pn <NAME>)

Options

-h, no-headers=<noHeaders> -pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

vc-storage-backup-policy-list-schedule

Name

vc-storage-backup-policy-list-schedule - List schedules for the policy (-pg | -pn )

Synopsis

vc storage backup policy list schedule [-h=<noHeaders>] (-pg=<guid> | -pn=<name>)

Description

List schedules for the policy (-pg <GUID> | -pn <NAME>)

Options

-h, no-headers=<noHeaders> -pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

vc-storage-backup-policy-list-storage

Name

vc-storage-backup-policy-list-storage - List storages assigned to a policy (-pg | -pn )

Synopsis

vc storage backup policy list storage [-h=<noHeaders>] (-pg=<guid> | -pn=<name>)

Description

List storages assigned to a policy (-pg <GUID> | -pn <NAME>)

Options

-h, no-headers=<noHeaders> -pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

vc-storage-backup-policy

Name

vc-storage-backup-policy - Backup SLA

Synopsis

vc storage backup policy [COMMAND]

Description

Backup SLA

Commands

create

Create a new policy <NAME>

set

Set recovery plan policies and rules

delete

Delete policy (-pg <GUID> | -pn <NAME>)

details

Show details (-pg <GUID> | -pn <NAME>)

update

Modify policy name (-pg <GUID> | -pn <NAME>) -n <NAME>

addtag

Add auto-assignment tag (-pg <GUID> | -pn <NAME>) -t <TYPE> -a <TAG>

addrule

Add new rule to selected policy

removetag

Remove auto-assignment tag (-pg <GUID> | -pn <NAME>) -t <ASSIGN_TYPE> -a <TAG>

removerule

Remove rules from policy (-pg <GUID> | -pn <NAME>) -r <RULE_GUID>,…​,<RULE_GUID>

inc

Run incremental backup for selected policy

full

Run full backup for selected policy

fail

Fails rest of the backup tasks

list

Lists recovery plan policies and rules

vc-storage-backup-policy-removerule

Name

vc-storage-backup-policy-removerule - Remove rules from policy (-pg | -pn ) -r ,...,

Synopsis

vc storage backup policy removerule -r=<rule>[,<rule>…​] [-r=<rule>[, <rule>…​]]…​ (-pg=<guid> | -pn=<name>)

Description

Remove rules from policy (-pg <GUID> | -pn <NAME>) -r <RULE_GUID>,…​,<RULE_GUID>

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-r, rule**=<rule>[,<rule>*…​] <GUID>,…​,<GUID> (no spaces)

vc-storage-backup-policy-removetag

Name

vc-storage-backup-policy-removetag - Remove auto-assignment tag (-pg | -pn ) -t -a

Synopsis

vc storage backup policy removetag -a=<tag> -t=<type> (-pg=<guid> | -pn=<name>)

Description

Remove auto-assignment tag (-pg <GUID> | -pn <NAME>) -t <ASSIGN_TYPE> -a <TAG>

Options

-pg,policy-guid=<guid>

Backup policy guid

-pn,policy-name=<name>

Backup policy name

-t, type**=<type>*

Types: INCLUDE, EXCLUDE

-a, tag**=<tag>*

vc-storage-backup-policy-set-activation

Name

vc-storage-backup-policy-set-activation - Set policy's activation state (-pg | -pn ) -a

Synopsis

vc storage backup policy set activation -a=<active> (-pg=<guid> | -pn=<name>)

Description

Set policy’s activation state (-pg <GUID> | -pn <NAME>) -a <YES | NO>

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-a, active=<active> YES or NO

vc-storage-backup-policy-set

Name

vc-storage-backup-policy-set - Set recovery plan policies and rules

Synopsis

vc storage backup policy set [COMMAND]

Description

Set recovery plan policies and rules

Commands

activation

Set policy’s activation state (-pg <GUID> | -pn <NAME>) -a <YES | NO>

removal

Set auto-removal of non-present (-pg <GUID> | -pn <NAME>) -a <YES | NO>

mode

Set auto-assignment mode (-pg <GUID> | -pn <NAME>) -m <MODE>

priority

Set policy’s backup task priority -g <GUID> -p <PRIORITY>

vc-storage-backup-policy-set-mode

Name

vc-storage-backup-policy-set-mode - Set auto-assignment mode (-pg | -pn ) -m

Synopsis

vc storage backup policy set mode -m=<mode> (-pg=<guid> | -pn=<name>)

Description

Set auto-assignment mode (-pg <GUID> | -pn <NAME>) -m <MODE>

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-m, mode**=<mode>* Modes: DISABLED, ASSIGN_ONLY, ASSIGN_AND_REMOVE

vc-storage-backup-policy-set-priority

Name

vc-storage-backup-policy-set-priority - Set policy's backup task priority -g -p

Synopsis

vc storage backup policy set priority -p=<priority> (-pg=<guid> | -pn=<name>)

Description

Set policy’s backup task priority -g <GUID> -p <PRIORITY>

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-p, priority**=<priority>* Range: 0-100 (50 default)

vc-storage-backup-policy-set-removal

Name

vc-storage-backup-policy-set-removal - Set auto-removal of non-present (-pg | -pn ) -a

Synopsis

vc storage backup policy set removal -a=<auto> (-pg=<guid> | -pn=<name>)

Description

Set auto-removal of non-present (-pg <GUID> | -pn <NAME>) -a <YES | NO>

Options

-pg,policy-guid=<guid> Backup policy guid

-pn,policy-name=<name> Backup policy name

-a, auto**=<auto>* YES or NO

vc-storage-backup-policy-update

Name

vc-storage-backup-policy-update - Modify policy name (-pg | -pn ) -n

Synopsis

vc storage backup policy update -n=<name> (-pg=<guid> | -pn=<name>)

Description

Modify policy name (-pg <GUID> | -pn <NAME>) -n <NAME>

Options

-pg,policy-guid=<guid>

Backup policy guid

-pn,policy-name=<name>

Backup policy name

-n, name=<name>

vc-storage-backup-schedule-active

Name

vc-storage-backup-schedule-active - Set schedule to be active (YES or NO) -g -a

Synopsis

vc storage 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

vc-storage-backup-schedule-create

Name

vc-storage-backup-schedule-create - Create new schedule

Synopsis

vc storage backup schedule create [-a=<active>] -b=<backupType> -d=<duration> -e=<scheduleExecutionType> -n=<name> -s=<scheduleType> -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> -s, sched-type**=<scheduleType>* Types: STORAGE_BACKUP, STORAGE_SNAPSHOT

-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 disabled

vc-storage-backup-schedule-delete

Name

vc-storage-backup-schedule-delete - Delete schedule

Synopsis

vc storage backup schedule delete (-pg=<policyGuid> | -pn=<policyName>)

Description

Delete schedule <GUID>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

vc-storage-backup-schedule-details

Name

vc-storage-backup-schedule-details - Show schedule details

Synopsis

vc storage backup schedule details <guid>

Description

Show schedule details <GUID>

Arguments

<guid>

vc-storage-backup-schedule-listb

Name

vc-storage-backup-schedule-listb - List storage backup schedules

Synopsis

vc storage backup schedule listb [-h=<noHeaders>]

Description

List storage backup schedules

Options

-h, no-headers=<noHeaders>

vc-storage-backup-schedule

Name

vc-storage-backup-schedule - Backup policy schedules

Synopsis

vc storage backup schedule [COMMAND]

Description

Backup policy schedules

Commands

listb

List storage backup 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

policy

Add policy

vc-storage-backup-schedule-policy

Name

vc-storage-backup-schedule-policy - Add policy

Synopsis

vc storage backup schedule policy (-s=<guid> | -sn=<name>) (-p=<guid> | -pn=<name>)

Description

Add policy

Options

-s, sched-guid=<guid> Schedule guid

-sn,sched-name=<name> Schedule name

-p, policy-guid=<guid> Policy guid

-pn,policy-name=<name> Policy name

vc-storage-backup-schedule-update

Name

vc-storage-backup-schedule-update - Update schedule

Synopsis

vc storage backup schedule update -b=<backupType> -d=<duration> -g=<guid> -n=<name> -se=<scheduleExecutionType> -t=<time> -dw=<daysOfWeek> [-dw=<daysOfWeek>]…​ -m=<months> [-m=<months>]…​ -o=<occurrence> [-o=<occurrence>]…​

Description

Update schedule

Options

-g, guid=<guid> -n, name=<name> -b, backup-type=<backupType> Types: FULL, INCREMENTAL, SYNTHETIC, SYNCHRONIZATION

-se,exec-type=<scheduleExecutionType> Schedule exec type. Types: TIME, INTERVAL

-t, time=<time> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR>

-d, duration=<duration> <DURATION | INTERVAL_FREQUENCY>

-dw,days-of-week=<daysOfWeek> <EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY>

-o, occurrence=<occurrence> <ANY, FIRST_IN_MONTH, SECOND_IN_MONTH, THIRD_IN_MONTH, FOURTH_IN_MONTH, LAST_IN_MONTH>

-m, months=<months> <ANY, JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER>

vc-storage-inf

Name

vc-storage-inf - Storage infrastructure

Synopsis

vc storage inf [COMMAND]

Description

Storage infrastructure

Commands

provider

Storage Provider instances

pool

Storage Pool instances

vc-storage-inf-pool-delete

Name

vc-storage-inf-pool-delete - Delete Storage Pool (-sg | -sn )

Synopsis

vc storage inf pool delete (-sg=<guid> | -sn=<name>)

Description

Delete Storage Pool (-sg <GUID> | -sn <NAME>)

Options

-sg,storage-pool-guid=<guid> Storage pool guid

-sn,storage-pool-name=<name> Storage pool name

vc-storage-inf-pool-list

Name

vc-storage-inf-pool-list - List Storage Pools

Synopsis

vc storage inf pool list [-h=<noHeaders>]

Description

List Storage Pools

Options

-h, no-headers=<noHeaders>

vc-storage-inf-pool

Name

vc-storage-inf-pool - Storage Pool instances

Synopsis

vc storage inf pool [COMMAND]

Description

Storage Pool instances

Commands

delete

Delete Storage Pool (-sg <GUID> | -sn <NAME>)

list

List Storage Pools

name

Set Storage Pool name (-sg <GUID> | -sn <NAME>)-n <NAME>

vc-storage-inf-pool-name

Name

vc-storage-inf-pool-name - Set Storage Pool name (-sg | -sn )-n

Synopsis

vc storage inf pool name -n=<name> (-sg=<guid> | -sn=<name>)

Description

Set Storage Pool name (-sg <GUID> | -sn <NAME>)-n <NAME>

Options

-sg,storage-pool-guid=<guid>

Storage pool guid

-sn,storage-pool-name=<name>

Storage pool name

-n, name=<name>

vc-storage-inf-provider-create-ceph

Name

vc-storage-inf-provider-create-ceph - Create CEPH Storage Provider -n -a -c -u

Synopsis

vc storage inf provider create ceph -a=<pathAuth> -c=<pathConf> -n=<name> -u=<user>

Description

Create CEPH Storage Provider -n <NAME> -a <PATH_TO_AUTH_FILE> -c <PATH_TO_CONFIG_FILE>-u <USER>

Options

-n, name=<name>

-a, pa**=<pathAuth>*

Path to authorization file

-c, pc**=<pathConf>*

Path to configuration file

-u, user=<user>

vc-storage-inf-provider-create-filesystem

Name

vc-storage-inf-provider-create-filesystem - Create File System Storage Provider

Synopsis

vc storage inf provider create filesystem <name>

Description

Create File System Storage Provider <NAME>

Arguments

<name>

vc-storage-inf-provider-create

Name

vc-storage-inf-provider-create - Storage Provider create recovery plan policies and rules

Synopsis

vc storage inf provider create [COMMAND]

Description

Storage Provider create recovery plan policies and rules

Commands

ceph

Create CEPH Storage Provider -n <NAME> -a <PATH_TO_AUTH_FILE> -c <PATH_TO_CONFIG_FILE>-u <USER>

nvg

Create Nutanix Volume Groups Storage Provider -n <NAME> -h <HOST> -u <USER> -p <PASSWORD>

nfiles

Create Nutanix Files/AFS Storage Provider -n <NAME> -h <HOST> -e <PRISM_ELEMENT_HOST> -u <USER> -p <PASSWORD>

filesystem

Create File System Storage Provider <NAME>

vc-storage-inf-provider-create-nfiles

Name

vc-storage-inf-provider-create-nfiles - Create Nutanix Files/AFS Storage Provider -n -h -e -u -p

Synopsis

vc storage inf provider create nfiles -e=<prismElementHost> -h=<host> -n=<name> -p=<password> -u=<user>

Description

Create Nutanix Files/AFS Storage Provider -n <NAME> -h <HOST> -e <PRISM_ELEMENT_HOST> -u <USER> -p <PASSWORD>

Options

-n, name=<name>

-h, host**=<host>*

-e, prism-element**=<prismElementHost>*

Prism element host

-u, user=<user>

-p, password=<password>

vc-storage-inf-provider-create-nvg

Name

vc-storage-inf-provider-create-nvg - Create Nutanix Volume Groups Storage Provider -n -h -u -p

Synopsis

vc storage inf provider create nvg -h=<host> -n=<name> -p=<password> -u=<user>

Description

Create Nutanix Volume Groups Storage Provider -n <NAME> -h <HOST> -u <USER> -p <PASSWORD>

Options

-n, name=<name>

-h, host**=<host>*

-u, user=<user>

-p, password=<password>

vc-storage-inf-provider-delete

Name

vc-storage-inf-provider-delete - Delete Storage Provider (-sg | -sn )

Synopsis

vc storage inf provider delete (-sg=<guid> | -sn=<name>)

Description

Delete Storage Provider (-sg <GUID> | -sn <NAME>)

Options

-sg,storage-provider-guid=<guid> Storage provider guid

-sn,storage-provider-name=<name> Storage provider name

vc-storage-inf-provider-details

Name

vc-storage-inf-provider-details - Show Storage Providers details (-sg | -sn )

Synopsis

vc storage inf provider details (-sg=<guid> | -sn=<name>)

Description

Show Storage Providers details (-sg <GUID> | -sn <NAME>)

Options

-sg,storage-provider-guid=<guid> Storage provider guid

-sn,storage-provider-name=<name> Storage provider name

vc-storage-inf-provider-listproviders

Name

vc-storage-inf-provider-listproviders - List Storage Providers

Synopsis

vc storage inf provider listproviders [-h=<noHeaders>]

Description

List Storage Providers

Options

-h, no-headers=<noHeaders>

vc-storage-inf-provider-lists

Name

vc-storage-inf-provider-lists - List Storages for Storage Provider (-sg | -sn )

Synopsis

vc storage inf provider lists [-h=<noHeaders>] (-sg=<guid> | -sn=<name>)

Description

List Storages for Storage Provider (-sg <GUID> | -sn <NAME>)

Options

-h, no-headers=<noHeaders> -sg,storage-provider-guid=<guid> Storage provider guid

-sn,storage-provider-name=<name> Storage provider name

vc-storage-inf-provider

Name

vc-storage-inf-provider - Storage Provider instances

Synopsis

vc storage inf provider [COMMAND]

Description

Storage Provider instances

Commands

create

Storage Provider create recovery plan policies and rules

set

Storage Provider set recovery plan policies and rules

delete

Delete Storage Provider (-sg <GUID> | -sn <NAME>)

details

Show Storage Providers details (-sg <GUID> | -sn <NAME>)

listproviders

List Storage Providers

lists

List Storages for Storage Provider (-sg <GUID> | -sn <NAME>)

sync

Synchronize inventory with Storage Provider (-sg <GUID> | -sn <NAME>)

update

Modify Storage Provider configuration (-sg <GUID> | -sn <NAME>) -n <PROPERTY_NO> -v <VALUE>

vc-storage-inf-provider-set-credentials

Name

vc-storage-inf-provider-set-credentials - Set user/password (-sg | -sn ) -u -p

Synopsis

vc storage inf provider set credentials -p=<password> -u=<user> (-sg=<guid> | -sn=<name>)

Description

Set user/password (-sg <GUID> | -sn <NAME>) -u <USER> -p <PASSWORD>

Options

-sg,storage-provider-guid=<guid>

Storage provider guid

-sn,storage-provider-name=<name>

Storage provider name

-u, user=<user>

-p, password=<password>

vc-storage-inf-provider-set-host

Name

vc-storage-inf-provider-set-host - Set host for Storage Provider (-sg | -sn ) -h

Synopsis

vc storage inf provider set host -h=<host> (-sg=<guid> | -sn=<name>)

Description

Set host for Storage Provider (-sg <GUID> | -sn <NAME>) -h <HOST>

Options

-sg,storage-provider-guid=<guid>

Storage provider guid

-sn,storage-provider-name=<name>

Storage provider name

-h, host**=<host>*

vc-storage-inf-provider-set

Name

vc-storage-inf-provider-set - Storage Provider set recovery plan policies and rules

Synopsis

vc storage inf provider set [COMMAND]

Description

Storage Provider set recovery plan policies and rules

Commands

host

Set host for Storage Provider (-sg <GUID> | -sn <NAME>) -h <HOST>

nodeconf

Set node config for Storage Provider (-sg <GUID> | -sn <NAME>) (-ncg <NODE_CONFIG_GUID> | -ncn <NODE_CONFIG_NAME>)

credentials

Set user/password (-sg <GUID> | -sn <NAME>) -u <USER> -p <PASSWORD>

vc-storage-inf-provider-set-nodeconf

Name

vc-storage-inf-provider-set-nodeconf - Set node config for Storage Provider (-sg | -sn ) (-ncg | -ncn )

Synopsis

vc storage inf provider set nodeconf (-sg=<guid> | -sn=<name>) (-ncg=<guid> | -ncn=<name>)

Description

Set node config for Storage Provider (-sg <GUID> | -sn <NAME>) (-ncg <NODE_CONFIG_GUID> | -ncn <NODE_CONFIG_NAME>)

Options

-sg,storage-provider-guid=<guid> Storage provider guid

-sn,storage-provider-name=<name> Storage provider name

-ncg,node-config-guid=<guid> Node configuration guid

-ncn,node-config-name=<name> Node configuration name

vc-storage-inf-provider-sync

Name

vc-storage-inf-provider-sync - Synchronize inventory with Storage Provider (-sg | -sn )

Synopsis

vc storage inf provider sync (-sg=<guid> | -sn=<name>)

Description

Synchronize inventory with Storage Provider (-sg <GUID> | -sn <NAME>)

Options

-sg,storage-provider-guid=<guid> Storage provider guid

-sn,storage-provider-name=<name> Storage provider name

vc-storage-inf-provider-update

Name

vc-storage-inf-provider-update - Modify Storage Provider configuration (-sg | -sn ) -n -v

Synopsis

vc storage inf provider update -n=<number> -v=<value> (-sg=<guid> | -sn=<name>)

Description

Modify Storage Provider configuration (-sg <GUID> | -sn <NAME>) -n <PROPERTY_NO> -v <VALUE>

Options

-sg,storage-provider-guid=<guid>

Storage provider guid

-sn,storage-provider-name=<name>

Storage provider name

-n, number**=<number>*

-v, value**=<value>*

vc-storage-inst

Name

vc-storage-inst - Storage instances

Synopsis

vc storage inst [COMMAND]

Description

Storage instances

Commands

mg

Storage instances policy

bar

Storage backup & restore policy

vc-storage-inst-bar-backup-full

Name

vc-storage-inst-bar-backup-full - Backup (full) (-pg | -pn ) -r ,...,

Synopsis

vc storage inst bar backup full -r=<rules>[,<rules>…​] [-r=<rules>[, <rules>…​]]…​ (-pg=<guid> | -pn=<name>)

Description

Backup (full) (-pg <GUID> | -pn <NAME>) -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

Options

-pg,policy-backup-guid=<guid> Storage backup policy guid

-pn,policy-backup-name=<name> Storage backup policy name

-r, rule**=<rules>[,<rules>*…​] Backup Rule GUID

vc-storage-inst-bar-backup-fullp

Name

vc-storage-inst-bar-backup-fullp - Backup (full) with ask priority (0-100, 50 = default) (-pg | -pn ) -p -r ,...,

Synopsis

vc storage inst bar backup fullp -p=<priority> -r=<rules>[,<rules>…​] [-r=<rules>[,<rules>…​]]…​ (-pg=<guid> | -pn=<name>)

Description

Backup (full) with ask priority (0-100, 50 = default) (-pg <GUID> | -pn <NAME>) -p <PRIORITY> -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

Options

-pg,policy-backup-guid=<guid> Storage backup policy guid

-pn,policy-backup-name=<name> Storage backup policy name

-r, rule**=<rules>[,<rules>*…​] Backup Rule GUID

-p, priority**=<priority>* Range: 0-100 (50 default)

vc-storage-inst-bar-backup-inc

Name

vc-storage-inst-bar-backup-inc - Backup storage (incremental) (-pg | -pn ) -r ,...,

Synopsis

vc storage inst bar backup inc -r=<rules>[,<rules>…​] [-r=<rules>[, <rules>…​]]…​ (-pg=<guid> | -pn=<name>)

Description

Backup storage (incremental) (-pg <GUID> | -pn <NAME>) -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

Options

-pg,policy-backup-guid=<guid> Storage backup policy guid

-pn,policy-backup-name=<name> Storage backup policy name

-r, rule**=<rules>[,<rules>*…​] Backup Rule GUID

vc-storage-inst-bar-backup-incp

Name

vc-storage-inst-bar-backup-incp - Backup storage (incremental) with task priority (0-100, 50 = default) (-pg | -pn ) -p -r ,...,

Synopsis

vc storage inst bar backup incp -p=<priority> -r=<rules>[,<rules>…​] [-r=<rules>[,<rules>…​]]…​ (-pg=<guid> | -pn=<name>)

Description

Backup storage (incremental) with task priority (0-100, 50 = default) (-pg <GUID> | -pn <NAME>) -p <PRIORITY> -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

Options

-pg,policy-backup-guid=<guid> Storage backup policy guid

-pn,policy-backup-name=<name> Storage backup policy name

-r, rule**=<rules>[,<rules>*…​] Backup Rule GUID

-p, priority**=<priority>* Range: 0-100 (50 default)

vc-storage-inst-bar-backup

Name

vc-storage-inst-bar-backup - Run backup policy

Synopsis

vc storage inst bar backup [COMMAND]

Description

Run backup policy

Commands

full

Backup (full) (-pg <GUID> | -pn <NAME>) -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

fullp

Backup (full) with ask priority (0-100, 50 = default) (-pg <GUID> | -pn <NAME>) -p <PRIORITY> -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

inc

Backup storage (incremental) (-pg <GUID> | -pn <NAME>) -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

incp

Backup storage (incremental) with task priority (0-100, 50 = default) (-pg <GUID> | -pn <NAME>) -p <PRIORITY> -r <BACKUP_RULE_GUID>,…​,<BACKUP_RULE_GUID>

vc-storage-inst-bar-details

Name

vc-storage-inst-bar-details - Show backup details (-pg | -pn )

Synopsis

vc storage inst bar details (-pg=<guid> | -pn=<name>)

Description

Show backup details (-pg <GUID> | -pn <NAME>)

Options

-pg,policy-backup-guid=<guid> Storage backup policy guid

-pn,policy-backup-name=<name> Storage backup policy name

vc-storage-inst-bar-fdetails

Name

vc-storage-inst-bar-fdetails - Show file details (-pg | -pn )

Synopsis

vc storage inst bar fdetails (-pg=<guid> | -pn=<name>)

Description

Show file details (-pg <GUID> | -pn <NAME>)

Options

-pg,policy-backup-guid=<guid> Storage backup policy guid

-pn,policy-backup-name=<name> Storage backup policy name

vc-storage-inst-bar-list-backup

Name

vc-storage-inst-bar-list-backup - Backups list

Synopsis

vc storage inst bar list backup [-h=<noHeaders>]

Description

Backups list

Options

-h, no-headers=<noHeaders>

vc-storage-inst-bar-list-file

Name

vc-storage-inst-bar-list-file - List backup files -g

Synopsis

vc storage inst bar list file [-g=<guid>] [-h=<noHeaders>]

Description

List backup files -g <BACKUP_GUID>

Options

-g, guid=<guid>

Backup guid

-h, no-headers=<noHeaders>

vc-storage-inst-bar-list

Name

vc-storage-inst-bar-list - Lists policy

Synopsis

vc storage inst bar list [COMMAND]

Description

Lists policy

Commands

backup

Backups list

file

List backup files -g <BACKUP_GUID>

task

List backup files -g <BACKUP_GUID>

vc-storage-inst-bar-list-task

Name

vc-storage-inst-bar-list-task - List backup files -g

Synopsis

vc storage inst bar list task [-g=<guid>] [-h=<noHeaders>]

Description

List backup files -g <BACKUP_GUID>

Options

-g, guid=<guid>

Backup guid

-h, no-headers=<noHeaders>

vc-storage-inst-bar

Name

vc-storage-inst-bar - Storage backup & restore policy

Synopsis

vc storage inst bar [COMMAND]

Description

Storage backup & restore policy

Commands

backup

Run backup policy

details

Show backup details (-pg <GUID> | -pn <NAME>)

fdetails

Show file details (-pg <GUID> | -pn <NAME>)

status

Show backup status info (-pg <GUID> | -pn <NAME>)

list

Lists policy

restore

Restore the backup from backup location (-pg <GUID> | -pn <NAME>) -p <PATH>

restoresp

Restore the storage to the storage provider (-pg <GUID> | -pn <NAME>) (-sg <GUID> | -sn <NAME>) -p <PATH>

vc-storage-inst-bar-restore

Name

vc-storage-inst-bar-restore - Restore the backup from backup location (-pg | -pn ) -p

Synopsis

vc storage inst bar restore -p=<path> (-pg=<guid> | -pn=<name>)

Description

Restore the backup from backup location (-pg <GUID> | -pn <NAME>) -p <PATH>

Options

-pg,policy-backup-guid=<guid>

Storage backup policy guid

-pn,policy-backup-name=<name>

Storage backup policy name

-p, path=<path>

vc-storage-inst-bar-restoresp

Name

vc-storage-inst-bar-restoresp - Restore the storage to the storage provider (-pg | -pn ) (-sg | -sn ) -p

Synopsis

vc storage inst bar restoresp -p=<path> (-pg=<guid> | -pn=<name>) (-sg=<guid> | -sn=<name>)

Description

Restore the storage to the storage provider (-pg <GUID> | -pn <NAME>) (-sg <GUID> | -sn <NAME>) -p <PATH>

Options

-pg,policy-backup-guid=<guid>

Storage backup policy guid

-pn,policy-backup-name=<name>

Storage backup policy name

-sg,storage-provider-guid=<guid>

Storage provider guid

-sn,storage-provider-name=<name>

Storage provider name

-p, path=<path>

vc-storage-inst-bar-status

Name

vc-storage-inst-bar-status - Show backup status info (-pg | -pn )

Synopsis

vc storage inst bar status (-pg=<guid> | -pn=<name>)

Description

Show backup status info (-pg <GUID> | -pn <NAME>)

Options

-pg,policy-backup-guid=<guid> Storage backup policy guid

-pn,policy-backup-name=<name> Storage backup policy name

vc-storage-inst-mg-ackb

Name

vc-storage-inst-mg-ackb - Acknowledge warnings related to the backup

Synopsis

vc storage inst mg ackb <guid>

Description

Acknowledge warnings related to the backup <BACKUP_GUID>

Arguments

<guid>

vc-storage-inst-mg-acks

Name

vc-storage-inst-mg-acks - Acknowledge all backup warnings related to the Storage (-sg | -sn )

Synopsis

vc storage inst mg acks (-sg=<guid> | -sn=<name>)

Description

Acknowledge all backup warnings related to the Storage (-sg <GUID> | -sn <NAME>)

Options

-sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

vc-storage-inst-mg-ap

Name

vc-storage-inst-mg-ap - Assign Storage to the policy (-sg | -sn )(-pg | -pn )

Synopsis

vc storage inst mg ap (-sg=<guid> | -sn=<name>) (-pg=<guid> | -pn=<name>)

Description

Assign Storage to the policy (-sg <GUID> | -sn <NAME>)(-pg <GUID> | -pn <NAME>)

Options

-sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

-pg,policy-backup-guid=<guid> Storage backup policy guid

-pn,policy-backup-name=<name> Storage backup policy name

vc-storage-inst-mg-asp

Name

vc-storage-inst-mg-asp - Assign Storage to the snapshot policy (-sg | -sn ) (-pg | -pn )

Synopsis

vc storage inst mg asp (-pg=<policyGuid> | -pn=<policyName>) (-sg=<guid> | -sn=<name>)

Description

Assign Storage to the snapshot policy (-sg <GUID> | -sn <NAME>) (-pg <SNAPSHOT_POLICY_GUID> | -pn <SNAPSHOT_POLICY_NAME>)

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

-sg,storage-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

vc-storage-inst-mg-bdetails

Name

vc-storage-inst-mg-bdetails - Show backup details (-sg | -sn )

Synopsis

vc storage inst mg bdetails (-sg=<guid> | -sn=<name>)

Description

Show backup details (-sg <GUID> | -sn <NAME>)

Options

-sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

vc-storage-inst-mg-create

Name

vc-storage-inst-mg-create - Create storage instance

Synopsis

vc storage inst mg create <name>

Description

Create storage instance <NEW_NAME>

Arguments

<name>

vc-storage-inst-mg-delete

Name

vc-storage-inst-mg-delete - Delete storage (-sg | -sn )

Synopsis

vc storage inst mg delete (-sg=<guid> | -sn=<name>)

Description

Delete storage (-sg <GUID> | -sn <NAME>)

Options

-sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

vc-storage-inst-mg-details

Name

vc-storage-inst-mg-details - Show storage details (-sg | -sn )

Synopsis

vc storage inst mg details (-sg=<guid> | -sn=<name>)

Description

Show storage details (-sg <GUID> | -sn <NAME>)

Options

-sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

vc-storage-inst-mg-list-backup

Name

vc-storage-inst-mg-list-backup - List backups of the Storage (-sg | -sn )

Synopsis

vc storage inst mg list backup [-h=<noHeaders>] (-sg=<guid> | -sn=<name>)

Description

List backups of the Storage (-sg <GUID> | -sn <NAME>)

Options

-h, no-headers=<noHeaders> -sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

vc-storage-inst-mg-list

Name

vc-storage-inst-mg-list - Lists policy

Synopsis

vc storage inst mg list [COMMAND]

Description

Lists policy

Commands

storage

List storages

task

List tasks related to the Storage (-sg <GUID> | -sn <NAME>)

backup

List backups of the Storage (-sg <GUID> | -sn <NAME>)

vc-storage-inst-mg-list-storage

Name

vc-storage-inst-mg-list-storage - List storages

Synopsis

vc storage inst mg list storage [-h=<noHeaders>]

Description

List storages

Options

-h, no-headers=<noHeaders>

vc-storage-inst-mg-list-task

Name

vc-storage-inst-mg-list-task - List tasks related to the Storage (-sg | -sn )

Synopsis

vc storage inst mg list task [-h=<noHeaders>] (-sg=<guid> | -sn=<name>)

Description

List tasks related to the Storage (-sg <GUID> | -sn <NAME>)

Options

-h, no-headers=<noHeaders> -sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

vc-storage-inst-mg

Name

vc-storage-inst-mg - Storage instances policy

Synopsis

vc storage inst mg [COMMAND]

Description

Storage instances policy

Commands

list

Lists policy

set

Set policy

create

Create storage instance <NEW_NAME>

details

Show storage details (-sg <GUID> | -sn <NAME>)

delete

Delete storage (-sg <GUID> | -sn <NAME>)

bdetails

Show backup details (-sg <GUID> | -sn <NAME>)

ap

Assign Storage to the policy (-sg <GUID> | -sn <NAME>)(-pg <GUID> | -pn <NAME>)

asp

Assign Storage to the snapshot policy (-sg <GUID> | -sn <NAME>) (-pg <SNAPSHOT_POLICY_GUID> | -pn <SNAPSHOT_POLICY_NAME>)

update

Modify Storage configuration (-sg <GUID> | -sn <NAME>) -n <PROPERTY_NO> -v <VALUE>

ackb

Acknowledge warnings related to the backup <BACKUP_GUID>

acks

Acknowledge all backup warnings related to the Storage (-sg <GUID> | -sn <NAME>)

vc-storage-inst-mg-set-cmd

Name

vc-storage-inst-mg-set-cmd - Set pre/post-snapshot CMD as semi-colon-separated string (-sg | -sn ) -f

 -t  -s


Synopsis
    vc storage inst mg set cmd -f=<preOrPost> -t=<type> -s=<cmdString>[,
                           <cmdString>…​] [-s=<cmdString>[,<cmdString>…​]]…​
                           (-sg=<guid> | -sn=<name>)


Description
    Set pre/post-snapshot CMD as semi-colon-separated string (-sg <GUID> | -sn <NAME>) -f <PRE | POST> -t <CMD_TYPE> -s <CMD_STRING>


Options

-sg,policy-guid=<guid>

Storage guid

-sn,storage-name=<name>

Storage name

-f,for=<preOrPost>
-t,type=<type>
-s,string=<cmdString>[,<cmdString>…​]
# vc-storage-inst-mg-set-credentials

Name

vc-storage-inst-mg-set-credentials - Set SSH access credentials -n (-sg | -sn ) -u -p

Synopsis

vc storage inst mg set credentials -n=<name> -p=<password> -u=<user> (-sg=<guid> | -sn=<name>)

Description

Set SSH access credentials -n <NAME> (-sg <GUID> | -sn <NAME>) -u <SSH_USER> -p <SSH_PASSWORD>

Options

-sg,policy-guid=<guid>

Storage guid

-sn,storage-name=<name>

Storage name

-n, name=<name>

-u, user=<user>

-p, password=<password>

vc-storage-inst-mg-set-handling

Name

vc-storage-inst-mg-set-handling - Set handling for pre/post-snap standard error -g -f

 -h


Synopsis
    vc storage inst mg set handling -f=<preOrPost> -h=<handling> (-sg=<guid> |
                                -sn=<name>)


Description
    Set handling for pre/post-snap standard error -g <GUID> -f <PRE | POST> -h <HANDLING>


Options

-sg,policy-guid=<guid>

Storage guid

-sn,storage-name=<name>

Storage name

-f,for=<preOrPost>
-h,handling=<handling>
# vc-storage-inst-mg-set

Name

vc-storage-inst-mg-set - Set policy

Synopsis

vc storage inst mg set [COMMAND]

Description

Set policy

Commands

credentials

Set SSH access credentials -n <NAME> (-sg <GUID> | -sn <NAME>) -u <SSH_USER> -p <SSH_PASSWORD>

handling

Set handling for pre/post-snap standard error -g <GUID> -f <PRE | POST> -h <HANDLING>

cmd

Set pre/post-snapshot CMD as semi-colon-separated string (-sg <GUID> | -sn <NAME>) -f <PRE | POST> -t <CMD_TYPE> -s <CMD_STRING>

present

Set present statement (-sg <GUID> | -sn <NAME>) -p <PRESENT>

path

Set storage path (-sg <GUID> | -sn <NAME>) -p <PATH>

provider

Set storage provider (-sg <GUID> | -sn <NAME>) (-spg <GUID> | -spn <NAME>)

vc-storage-inst-mg-set-path

Name

vc-storage-inst-mg-set-path - Set storage path (-sg | -sn ) -p

Synopsis

vc storage inst mg set path -p=<path> (-sg=<guid> | -sn=<name>)

Description

Set storage path (-sg <GUID> | -sn <NAME>) -p <PATH>

Options

-sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

-p, path=<path> Path

vc-storage-inst-mg-set-present

Name

vc-storage-inst-mg-set-present - Set present statement (-sg | -sn ) -p

Synopsis

vc storage inst mg set present -p=<active> (-sg=<guid> | -sn=<name>)

Description

Set present statement (-sg <GUID> | -sn <NAME>) -p <PRESENT>

Options

-sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

-p, present**=<active>* Present YES or NO

vc-storage-inst-mg-set-provider

Name

vc-storage-inst-mg-set-provider - Set storage provider (-sg | -sn ) (-spg | -spn )

Synopsis

vc storage inst mg set provider (-sg=<guid> | -sn=<name>) (-spg=<guid> | -spn=<name>)

Description

Set storage provider (-sg <GUID> | -sn <NAME>) (-spg <GUID> | -spn <NAME>)

Options

-sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

-spg,storage-provider-guid=<guid> Storage provider guid

-spn,storage-provider-name=<name> Storage provider name

vc-storage-inst-mg-update

Name

vc-storage-inst-mg-update - Modify Storage configuration (-sg | -sn ) -n -v

Synopsis

vc storage inst mg update -n=<number> -v=<value> (-sg=<guid> | -sn=<name>)

Description

Modify Storage configuration (-sg <GUID> | -sn <NAME>) -n <PROPERTY_NO> -v <VALUE>

Options

-sg,policy-guid=<guid> Storage guid

-sn,storage-name=<name> Storage name

-n, number**=<number>* Property number

-v, value**=<value>* New value

vc-storage-mounted

Name

vc-storage-mounted - Mounted backups

Synopsis

vc storage mounted [COMMAND]

Description

Mounted backups

Commands

list

List commnads

mount

Mount backup according to the MOUNT_SPECIFICATION

-b <BACKUP_LOCATION_GUID>

-n <NODE_GUID | NODE_NAME>

-a <AUTO> -h <HOURS> -m <MOUNT_SPECIFICATION>

ms

Mount iSCSI. -b <BACKUP_LOCATION_GUID>

-n <NODE_CONFIG_GUID | NODE_CONFIG_NAME>

-a <ALLOWED_CLIENT>,…​,<ALLOWED_CLIENT>

-d <DISK_GUID>,…​,<DISK_GUID>

um

Unmount previously mounted backup -mg <GUID>

vc-storage-mounted-list-backups

Name

vc-storage-mounted-list-backups - List mounted backups

Synopsis

vc storage mounted list backups [-h=<noHeaders>]

Description

List mounted backups

Options

-h, no-headers=<noHeaders>

vc-storage-mounted-list-files

Name

vc-storage-mounted-list-files - List file systems -mg

Synopsis

vc storage mounted list files [-h=<noHeaders>] (-mg=<guid>)

Description

List file systems -mg <GUID>

Options

-mg,mounted-backup-guid=<guid>

Mounted backup guid

-h, no-headers=<noHeaders>

vc-storage-mounted-list-iscsi

Name

vc-storage-mounted-list-iscsi - List files for selected backup, that can be mounted using iSCSI mode. -mg

Synopsis

vc storage mounted list iscsi [-h=<noHeaders>] (-mg=<guid>)

Description

List files for selected backup, that can be mounted using iSCSI mode. -mg <GUID>

Options

-mg,mounted-backup-guid=<guid>

Mounted backup guid

-h, no-headers=<noHeaders>

vc-storage-mounted-list

Name

vc-storage-mounted-list - List commnads

Synopsis

vc storage mounted list [COMMAND]

Description

List commnads

Commands

files

List file systems -mg <GUID>

iscsi

List files for selected backup, that can be mounted using iSCSI mode. -mg <GUID>

backups

List mounted backups

mountedfiles

List mounted files -mg <GUID>

tasks

List tasks related to the mounted backup -mg <GUID>

vc-storage-mounted-list-mountedfiles

Name

vc-storage-mounted-list-mountedfiles - List mounted files -mg

Synopsis

vc storage mounted list mountedfiles [-h=<noHeaders>] (-mg=<guid>)

Description

List mounted files -mg <GUID>

Options

-mg,mounted-backup-guid=<guid>

Mounted backup guid

-h, no-headers=<noHeaders>

vc-storage-mounted-list-tasks

Name

vc-storage-mounted-list-tasks - List tasks related to the mounted backup -mg

Synopsis

vc storage mounted list tasks [-h=<noHeaders>] (-mg=<guid>)

Description

List tasks related to the mounted backup -mg <GUID>

Options

-mg,mounted-backup-guid=<guid>

Mounted backup guid

-h, no-headers=<noHeaders>

vc-storage-mounted-mount

Name

vc-storage-mounted-mount - Mount backup according to the MOUNT_SPECIFICATION -b -n -a -h -m

Synopsis

vc storage mounted mount -a=<auto> -b=<backupLocation> -h=<hours> -m=<mount> -n=<node>

Description

Mount backup according to the MOUNT_SPECIFICATION -b <BACKUP_LOCATION_GUID> -n <NODE_GUID | NODE_NAME> -a <AUTO> -h <HOURS> -m <MOUNT_SPECIFICATION>

Options

-b, backup**=<backupLocation>* Backup location GUID

-n, node**=<node>* Node GUID or NAME

-a, auto**=<auto>* If auto - YES, manual - NO

-h, hours**=<hours>* Hours to auto unmount

-m, mount**=<mount>* Mount specification

vc-storage-mounted-ms

Name

vc-storage-mounted-ms - Mount iSCSI. -b -n -a ,..., -d ,...,

Synopsis

vc storage mounted ms -b=<backupLocation> -n=<nodeConfig> -a=<allowedClients>[, <allowedClients>…​] [-a=<allowedClients>[, <allowedClients>…​]]…​ -d=<disks>[,<disks>…​] [-d=<disks>[,<disks>…​]]…​

Description

Mount iSCSI. -b <BACKUP_LOCATION_GUID> -n <NODE_CONFIG_GUID | NODE_CONFIG_NAME> -a <ALLOWED_CLIENT>,…​,<ALLOWED_CLIENT> -d <DISK_GUID>,…​,<DISK_GUID>

Options

-b, backup**=<backupLocation>* Backup location GUID

-n, node-config**=<nodeConfig>* Node Config GUID or NAME

-a, allowed-client**=<allowedClients>[,<allowedClients>*…​] GUID,…​,GUID (No spaces)

-d, disk**=<disks>[,<disks>*…​] GUID,…​,GUID (No spaces)

vc-storage-mounted-um

Name

vc-storage-mounted-um - Unmount previously mounted backup -mg

Synopsis

vc storage mounted um (-mg=<guid>)

Description

Unmount previously mounted backup -mg <GUID>

Options

-mg,mounted-backup-guid=<guid> Mounted backup guid

vc-storage-snapshot

Name

vc-storage-snapshot - Snapshot SLA

Synopsis

vc storage snapshot [COMMAND]

Description

Snapshot SLA

Commands

policy

Snapshot SLA

schedule

Schedule instances

vc-storage-snapshot-policy-addrule

Name

vc-storage-snapshot-policy-addrule - Add new rule to selected policy -n (-pg | -pn ) -r -v

Synopsis

vc storage snapshot policy addrule -n=<name> -r=<days> -v=<version> (-pg=<policyGuid> | -pn=<policyName>)

Description

Add new rule to selected policy -n <NAME> (-pg <GUID> | -pn <NAME>) -r <RETENTION_DAYS> -v <RETENTION_VERSIONS>

Options

-pg,policy-snapshot-guid=<policyGuid>

Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName>

Storage snapshot policy name

-n, name=<name>

-r, retention-days**=<days>*

-v, retention-version**=<version>*

vc-storage-snapshot-policy-addtag

Name

vc-storage-snapshot-policy-addtag - Add auto-assignment tag -g -t -a

Synopsis

vc storage snapshot policy addtag -a=<tag> -t=<type> (-pg=<policyGuid> | -pn=<policyName>)

Description

Add auto-assignment tag -g <GUID> -t <TYPE> -a <TAG>

Options

-pg,policy-snapshot-guid=<policyGuid>

Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName>

Storage snapshot policy name

-t, type**=<type>*

Types: INCLUDE, EXCLUDE

-a, tag**=<tag>*

vc-storage-snapshot-policy-assign

Name

vc-storage-snapshot-policy-assign - Assign Storages to the policy (-pg | -pn ) -s ,...,

Synopsis

vc storage snapshot policy assign -s=<storages>[,<storages>…​] [-s=<storages>[, <storages>…​]]…​ (-pg=<policyGuid> | -pn=<policyName>)

Description

Assign Storages to the policy (-pg <GUID> | -pn <NAME>) -s <STORAGE_GUID>,…​,<STORAGE_GUID>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

-s, storages-guid**=<storages>[,<storages>*…​] GUID,…​,GUID (No spaces)

vc-storage-snapshot-policy-create

Name

vc-storage-snapshot-policy-create - Create a new policy

Synopsis

vc storage snapshot policy create <name>

Description

Create a new policy <NAME>

Arguments

<name>

vc-storage-snapshot-policy-delete

Name

vc-storage-snapshot-policy-delete - Delete policy

Synopsis

vc storage snapshot policy delete (-pg=<policyGuid> | -pn=<policyName>)

Description

Delete policy <GUID>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

vc-storage-snapshot-policy-details

Name

vc-storage-snapshot-policy-details - Show details

Synopsis

vc storage snapshot policy details (-pg=<policyGuid> | -pn=<policyName>)

Description

Show details <GUID>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

vc-storage-snapshot-policy-list

Name

vc-storage-snapshot-policy-list - Lists commands

Synopsis

vc storage snapshot policy list [COMMAND]

Description

Lists commands

Commands

policy

List snapshot policies

storages

List storages in snapshot storage policy (-pg <GUID> | -pn <NAME>)

rule

List rules in the policy (-pg <GUID> | -pn <NAME>)

vc-storage-snapshot-policy-list-policy

Name

vc-storage-snapshot-policy-list-policy - List snapshot policies

Synopsis

vc storage snapshot policy list policy [-h=<noHeaders>]

Description

List snapshot policies

Options

-h, no-headers=<noHeaders>

vc-storage-snapshot-policy-list-rule

Name

vc-storage-snapshot-policy-list-rule - List rules in the policy (-pg | -pn )

Synopsis

vc storage snapshot policy list rule [-h=<noHeaders>] (-pg=<policyGuid> | -pn=<policyName>)

Description

List rules in the policy (-pg <GUID> | -pn <NAME>)

Options

-h, no-headers=<noHeaders> -pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

vc-storage-snapshot-policy-list-storages

Name

vc-storage-snapshot-policy-list-storages - List storages in snapshot storage policy (-pg | -pn )

Synopsis

vc storage snapshot policy list storages [-h=<noHeaders>] (-pg=<policyGuid> | -pn=<policyName>)

Description

List storages in snapshot storage policy (-pg <GUID> | -pn <NAME>)

Options

-h, no-headers=<noHeaders> -pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

vc-storage-snapshot-policy

Name

vc-storage-snapshot-policy - Snapshot SLA

Synopsis

vc storage snapshot policy [COMMAND]

Description

Snapshot SLA

Commands

list

Lists commands

set

Set commands

create

Create a new policy <NAME>

delete

Delete policy <GUID>

details

Show details <GUID>

update

Modify policy name -g <GUID> -n <NAME>

addtag

Add auto-assignment tag -g <GUID> -t <TYPE> -a <TAG>

removetag

Remove auto-assignment tag -g <GUID> -t <RETENTION_DAYS> -a <TAG>

addrule

Add new rule to selected policy -n <NAME> (-pg <GUID> | -pn <NAME>) -r <RETENTION_DAYS> -v <RETENTION_VERSIONS>

removerule

Remove rules from policy -g <POLICY_GUID> -r <RULE_GUID>,…​,<RULE_GUID>

assign

Assign Storages to the policy (-pg <GUID> | -pn <NAME>) -s <STORAGE_GUID>,…​,<STORAGE_GUID>

unassign

Unassign Storages from the policy <STORAGE_GUID>,…​,<STORAGE_GUID>

vc-storage-snapshot-policy-removerule

Name

vc-storage-snapshot-policy-removerule - Remove rules from policy -g -r ,...,

Synopsis

vc storage snapshot policy removerule -r=<rule>[,<rule>…​] [-r=<rule>[, <rule>…​]]…​ (-pg=<policyGuid> | -pn=<policyName>)

Description

Remove rules from policy -g <POLICY_GUID> -r <RULE_GUID>,…​,<RULE_GUID>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

-r, rule**=<rule>[,<rule>*…​] GUID,…​,GUID (No spaces)

vc-storage-snapshot-policy-removetag

Name

vc-storage-snapshot-policy-removetag - Remove auto-assignment tag -g -t -a

Synopsis

vc storage snapshot policy removetag -a=<tag> -t=<type> (-pg=<policyGuid> | -pn=<policyName>)

Description

Remove auto-assignment tag -g <GUID> -t <RETENTION_DAYS> -a <TAG>

Options

-pg,policy-snapshot-guid=<policyGuid>

Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName>

Storage snapshot policy name

-t, type**=<type>*

Types: INCLUDE, EXCLUDE

-a, tag**=<tag>*

vc-storage-snapshot-policy-set-activation

Name

vc-storage-snapshot-policy-set-activation - Set policy activation state (-pg | -pn ) -a

Synopsis

vc storage snapshot policy set activation -a=<active> (-pg=<policyGuid> | -pn=<policyName>)

Description

Set policy activation state (-pg <GUID> | -pn <NAME>) -a <YES | NO>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

-a, active=<active> YES or NO

vc-storage-snapshot-policy-set-auto

Name

vc-storage-snapshot-policy-set-auto - Set auto-assignment HV clusters (-pg | -pn ) -c ...

Synopsis

vc storage snapshot policy set auto -c=<clusters> [-c=<clusters>]…​ (-pg=<guid> | -pn=<name>)

Description

Set auto-assignment HV clusters (-pg <GUID> | -pn <NAME>) -c <HV_CLUSTER_GUID>…​<HV_CLUSTER_GUID>

Options

-pg,policy-snapshot-guid=<guid> Storage snapshot policy guid

-pn,policy-snapshot-name=<name> Storage snapshot policy name

-c, clusters**=<clusters>* Hypervisor clusters

vc-storage-snapshot-policy-set

Name

vc-storage-snapshot-policy-set - Set commands

Synopsis

vc storage snapshot policy set [COMMAND]

Description

Set commands

Commands

auto

Set auto-assignment HV clusters (-pg <GUID> | -pn <NAME>) -c <HV_CLUSTER_GUID>…​<HV_CLUSTER_GUID>

activation

Set policy activation state (-pg <GUID> | -pn <NAME>) -a <YES | NO>

removal

Set auto-removal of non-present VMs flag (-pg <GUID> | -pn <NAME>) -a <YES | NO>

mode

Set auto-assignment mode (-pg <GUID> | -pn <NAME>) -m <MODE>

priority

Set policy’s backup task priority (-pg <GUID> | -pn <NAME>) -p <PRIORITY>

retry

Set snapshot policy retry count (-pg <GUID> | -pn <NAME>)-r <RETRY_COUNT>

vc-storage-snapshot-policy-set-mode

Name

vc-storage-snapshot-policy-set-mode - Set auto-assignment mode (-pg | -pn ) -m

Synopsis

vc storage snapshot policy set mode -m=<mode> (-pg=<policyGuid> | -pn=<policyName>)

Description

Set auto-assignment mode (-pg <GUID> | -pn <NAME>) -m <MODE>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

-m, mode**=<mode>* Modes: DISABLED, ASSIGN_ONLY, ASSIGN_AND_REMOVE

vc-storage-snapshot-policy-set-priority

Name

vc-storage-snapshot-policy-set-priority - Set policy's backup task priority (-pg | -pn ) -p

Synopsis

vc storage snapshot policy set priority -p=<priority> (-pg=<policyGuid> | -pn=<policyName>)

Description

Set policy’s backup task priority (-pg <GUID> | -pn <NAME>) -p <PRIORITY>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

-p, priority**=<priority>* Range: 0-100 (50 default)

vc-storage-snapshot-policy-set-removal

Name

vc-storage-snapshot-policy-set-removal - Set auto-removal of non-present VMs flag (-pg | -pn ) -a

Synopsis

vc storage snapshot policy set removal -a=<auto> (-pg=<policyGuid> | -pn=<policyName>)

Description

Set auto-removal of non-present VMs flag (-pg <GUID> | -pn <NAME>) -a <YES | NO>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

-a, auto**=<auto>* YES or NO

vc-storage-snapshot-policy-set-retry

Name

vc-storage-snapshot-policy-set-retry - Set snapshot policy retry count (-pg | -pn )-r

Synopsis

vc storage snapshot policy set retry -r=<retryCount> (-pg=<policyGuid> | -pn=<policyName>)

Description

Set snapshot policy retry count (-pg <GUID> | -pn <NAME>)-r <RETRY_COUNT>

Options

-pg,policy-snapshot-guid=<policyGuid> Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName> Storage snapshot policy name

-r, retry-count**=<retryCount>* Snapshot retry count

vc-storage-snapshot-policy-unassign

Name

vc-storage-snapshot-policy-unassign - Unassign Storages from the policy ,...,

Synopsis

vc storage snapshot policy unassign [<guids>[,<guids>…​]…​]

Description

Unassign Storages from the policy <STORAGE_GUID>,…​,<STORAGE_GUID>

Arguments

[<guids>[,<guids>…​]…​] GUID,…​,GUID (No spaces)

vc-storage-snapshot-policy-update

Name

vc-storage-snapshot-policy-update - Modify policy name -g -n

Synopsis

vc storage snapshot policy update -n=<name> (-pg=<policyGuid> | -pn=<policyName>)

Description

Modify policy name -g <GUID> -n <NAME>

Options

-pg,policy-snapshot-guid=<policyGuid>

Storage snapshot policy guid

-pn,policy-snapshot-name=<policyName>

Storage snapshot policy name

-n, new-name**=<name>*

vc-storage-snapshot-schedule-active

Name

vc-storage-snapshot-schedule-active - Set schedule to be active (YES or NO) -g -a

Synopsis

vc storage snapshot 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

vc-storage-snapshot-schedule-create

Name

vc-storage-snapshot-schedule-create - Create new schedule

Synopsis

vc storage snapshot schedule create [-a=<active>] -b=<backupType> -d=<duration> -e=<scheduleExecutionType> -n=<name> -s=<scheduleType> -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> -s, sched-type**=<scheduleType>* Types: STORAGE_BACKUP, STORAGE_SNAPSHOT

-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 disabled

vc-storage-snapshot-schedule-delete

Name

vc-storage-snapshot-schedule-delete - Delete schedule

Synopsis

vc storage snapshot schedule delete (-sg=<policyGuid> | -sn=<policyName>)

Description

Delete schedule <GUID>

Options

-sg,snapshot-guid=<policyGuid> Storage snapshot schedule guid

-sn,snapshot-name=<policyName> Storage snapshot schedule name

vc-storage-snapshot-schedule-details

Name

vc-storage-snapshot-schedule-details - Show schedule details

Synopsis

vc storage snapshot schedule details <guid>

Description

Show schedule details <GUID>

Arguments

<guid>

vc-storage-snapshot-schedule-listb

Name

vc-storage-snapshot-schedule-listb - List storage backup schedules

Synopsis

vc storage snapshot schedule listb [-h=<noHeaders>]

Description

List storage backup schedules

Options

-h, no-headers=<noHeaders>

vc-storage-snapshot-schedule-lists

Name

vc-storage-snapshot-schedule-lists - List storage snapshot schedules

Synopsis

vc storage snapshot schedule lists [-h=<noHeaders>]

Description

List storage snapshot schedules

Options

-h, no-headers=<noHeaders>

vc-storage-snapshot-schedule

Name

vc-storage-snapshot-schedule - Schedule instances

Synopsis

vc storage snapshot schedule [COMMAND]

Description

Schedule instances

Commands

listb

List storage backup schedules

lists

List storage snapshot 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

policy

Add policy

vc-storage-snapshot-schedule-policy

Name

vc-storage-snapshot-schedule-policy - Add policy

Synopsis

vc storage snapshot schedule policy (-s=<guid> | -sn=<name>) (-p=<guid> | -pn=<name>)

Description

Add policy

Options

-s, sched-guid=<guid> Schedule guid

-sn,sched-name=<name> Schedule name

-p, policy-guid=<guid> Policy guid

-pn,policy-name=<name> Policy name

vc-storage-snapshot-schedule-update

Name

vc-storage-snapshot-schedule-update - Update schedule

Synopsis

vc storage snapshot schedule update -b=<backupType> -d=<duration> -g=<guid> -n=<name> -se=<scheduleExecutionType> -t=<time> -dw=<daysOfWeek> [-dw=<daysOfWeek>]…​ -m=<months> [-m=<months>]…​ -o=<occurrence> [-o=<occurrence>]…​

Description

Update schedule

Options

-g, guid=<guid> -n, name=<name> -b, backup-type=<backupType> Types: FULL, INCREMENTAL, SYNTHETIC, SYNCHRONIZATION

-se,exec-type=<scheduleExecutionType> Schedule exec type. Types: TIME, INTERVAL

-t, time=<time> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR>

-d, duration=<duration> <DURATION | INTERVAL_FREQUENCY>

-dw,days-of-week=<daysOfWeek> <EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY>

-o, occurrence=<occurrence> <ANY, FIRST_IN_MONTH, SECOND_IN_MONTH, THIRD_IN_MONTH, FOURTH_IN_MONTH, LAST_IN_MONTH>

-m, months=<months> <ANY, JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER>

vc-task

Name

vc-task - TASK MANAGEMENT

Synopsis

vc task [COMMAND]

Description

TASK MANAGEMENT

Commands

delete

Delete/cancel task -g <GUID>

details

Show task details -g <GUID>

list

List commands

vc-task-delete

Name

vc-task-delete - Delete/cancel task -g

Synopsis

vc task delete -pg=<guid>

Description

Delete/cancel task -g <GUID>

Options

-pg,policy-guid=<guid> Snapshot policy guid

vc-task-details

Name

vc-task-details - Show task details -g

Synopsis

vc task details -pg=<guid>

Description

Show task details -g <GUID>

Options

-pg,policy-guid=<guid> Snapshot policy guid

vc-task-list-all

Name

vc-task-list-all - List tasks (all nodes and not assigned to any node)

Synopsis

vc task list all [-h=<noHeaders>]

Description

List tasks (all nodes and not assigned to any node)

Options

-h, no-headers=<noHeaders>

vc-task-list-finished

Name

vc-task-list-finished - List finished (including failed) tasks

Synopsis

vc task list finished [-h=<noHeaders>]

Description

List finished (including failed) tasks

Options

-h, no-headers=<noHeaders>

vc-task-list

Name

vc-task-list - List commands

Synopsis

vc task list [COMMAND]

Description

List commands

Commands

finished

List finished (including failed) tasks

all

List tasks (all nodes and not assigned to any node)

tasks

List tasks (this node only)

queued

List queued tasks

running

List running tasks

vc-task-list-queued

Name

vc-task-list-queued - List queued tasks

Synopsis

vc task list queued [-h=<noHeaders>]

Description

List queued tasks

Options

-h, no-headers=<noHeaders>

vc-task-list-running

Name

vc-task-list-running - List running tasks

Synopsis

vc task list running [-h=<noHeaders>]

Description

List running tasks

Options

-h, no-headers=<noHeaders>

vc-task-list-tasks

Name

vc-task-list-tasks - List tasks (this node only)

Synopsis

vc task list tasks [-h=<noHeaders>]

Description

List tasks (this node only)

Options

-h, no-headers=<noHeaders>

vc-ve

Name

vc-ve - VIRTUAL ENVIRONMENTS

Synopsis

vc ve [COMMAND]

Description

VIRTUAL ENVIRONMENTS

Commands

inst

Instances

inf

Infrastructure

backup

Backup SLA

snapshot

Snapshot SLA

recovery

Recovery plans

mounted

Mounted backups

vc-ve-backup

Name

vc-ve-backup - Backup SLA

Synopsis

vc ve backup [COMMAND]

Description

Backup SLA

Commands

policies

Policies instances

schedule

Policy schedules

vc-ve-backup-policies-addbd

Name

vc-ve-backup-policies-addbd - Add second backup destination to selected policy

Synopsis

vc ve backup policies addbd -b=<bdGuid> -k=<keep> -r=<ruleGUid> -rf=<fulldays> -ri=<incdays> -vf=<fullversion> -vi=<incversion> (-g=<guid> | -n=<name>)

Description

Add second backup destination to selected policy

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-r, rule**=<ruleGUid>* Rule GUID

-b, back-dest**=<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)

vc-ve-backup-policies-addrule

Name

vc-ve-backup-policies-addrule - Add new rule to selected policy

Synopsis

vc ve backup policies addrule -b=<bd> -k=<keep> -n=<name> -rf=<fulldays> -ri=<incdays> [-s=<schedule>] -vf=<fullversion> -vi=<incversion> (-p=<guid> | -pn=<name>)

Description

Add new rule to selected policy

Options

-p, guid=<guid> Policy guid

-pn,policy-name=<name> Policy name

-n, name=<name> New rule name

-s, schedule**=<schedule>* Schedule GUID

-b, back-dest**=<bd>* 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)

vc-ve-backup-policies-addtag

Name

vc-ve-backup-policies-addtag - Add auto-assignment tag (-g | -n ) -t -a

Synopsis

vc ve backup policies addtag -a=<tag> -t=<type> (-g=<guid> | -n=<name>)

Description

Add auto-assignment tag (-g <GUID> | -n <NAME>) -t <TYPE> -a <TAG>

Options

-g, guid=<guid>

Policy guid

-n, name=<name>

Policy name

-t, type**=<type>*

Types: INCLUDE, EXCLUDE

-a, tag**=<tag>*

vc-ve-backup-policies-assign

Name

vc-ve-backup-policies-assign - Assign VMs to the policy (-g | -n ) -v ,...,

Synopsis

vc ve backup policies assign [-v=<vmGuids>[,<vmGuids>…​]]…​ (-g=<guid> | -n=<name>)

Description

Assign VMs to the policy (-g <POLICY_GUID> | -n <POLICY_NAME>) -v <VM_GUID>,…​,<VM_GUID>

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-v, vms**=<vmGuids>[,<vmGuids>*…​] <GUID>,…​,<GUID> (no spaces)

vc-ve-backup-policies-create

Name

vc-ve-backup-policies-create - Create a new policy

Synopsis

vc ve backup policies create <name>

Description

Create a new policy <NAME>

Arguments

<name>

vc-ve-backup-policies-delete

Name

vc-ve-backup-policies-delete - Delete policy (-g | -n )

Synopsis

vc ve backup policies delete (-g=<guid> | -n=<name>)

Description

Delete policy (-g <GUID> | -n <NAME>)

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

vc-ve-backup-policies-details

Name

vc-ve-backup-policies-details - Show details (-g | -n )

Synopsis

vc ve backup policies details (-g=<guid> | -n=<name>)

Description

Show details (-g <GUID> | -n <NAME>)

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

vc-ve-backup-policies-full

Name

vc-ve-backup-policies-full - Run full backup for selected policy

Synopsis

vc ve backup policies full -p=<priority> -r=<retryCount> -v=<vms>[,<vms>…​] [-v=<vms>[,<vms>…​]]…​ (-g=<guid> | -n=<name>)

Description

Run full backup for selected policy

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-p, priority**=<priority>* Priority: 0-100, default: 50

-r, retry-count**=<retryCount>* -v, *vms*=<vms>[,<vms>*…​] <VM_GUID>,…​,<VM_GUID> (no spaces)

vc-ve-backup-policies-inc

Name

vc-ve-backup-policies-inc - Run incremental backup for selected policy

Synopsis

vc ve backup policies inc -p=<priority> -r=<retryCount> -v=<vms>[,<vms>…​] [-v=<vms>[,<vms>…​]]…​ (-g=<guid> | -n=<name>)

Description

Run incremental backup for selected policy

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-p, priority**=<priority>* Priority: 0-100, default: 50

-r, retry-count**=<retryCount>* -v, *vms*=<vms>[,<vms>*…​] <VM_GUID>,…​,<VM_GUID> (no spaces)

vc-ve-backup-policies-list

Name

vc-ve-backup-policies-list - Lists recovery plan policies and rules

Synopsis

vc ve backup policies list [COMMAND]

Description

Lists recovery plan policies and rules

Commands

policy

List backup policies

rule

List rules for virtual machine backup policy (-g <GUID> | -n <NAME>

vm

List VMs assigned to a policy (-g <GUID> | -n <NAME>)

schedule

List schedules for the policy (-g <GUID> | -n <NAME>)

vc-ve-backup-policies-list-policy

Name

vc-ve-backup-policies-list-policy - List backup policies

Synopsis

vc ve backup policies list policy [-h=<noHeaders>]

Description

List backup policies

Options

-h, no-headers=<noHeaders>

vc-ve-backup-policies-list-rule

Name

vc-ve-backup-policies-list-rule - List rules for virtual machine backup policy (-g | -n

Synopsis

vc ve backup policies list rule [-h=<noHeaders>] (-g=<guid> | -n=<name>)

Description

List rules for virtual machine backup policy (-g <GUID> | -n <NAME>

Options

-g, guid=<guid> Policy guid

-h, no-headers=<noHeaders> -n, name=<name> Policy name

vc-ve-backup-policies-list-schedule

Name

vc-ve-backup-policies-list-schedule - List schedules for the policy (-g | -n )

Synopsis

vc ve backup policies list schedule [-h=<noHeaders>] (-g=<guid> | -n=<name>)

Description

List schedules for the policy (-g <GUID> | -n <NAME>)

Options

-g, guid=<guid> Policy guid

-h, no-headers=<noHeaders> -n, name=<name> Policy name

vc-ve-backup-policies-list-vm

Name

vc-ve-backup-policies-list-vm - List VMs assigned to a policy (-g | -n )

Synopsis

vc ve backup policies list vm [-h=<noHeaders>] (-g=<guid> | -n=<name>)

Description

List VMs assigned to a policy (-g <GUID> | -n <NAME>)

Options

-g, guid=<guid> Policy guid

-h, no-headers=<noHeaders> Print headers

-n, name=<name> Policy name

vc-ve-backup-policies

Name

vc-ve-backup-policies - Policies instances

Synopsis

vc ve backup policies [COMMAND]

Description

Policies instances

Commands

list

Lists recovery plan policies and rules

set

Set recovery plan policies and rules

details

Show details (-g <GUID> | -n <NAME>)

create

Create a new policy <NAME>

delete

Delete policy (-g <GUID> | -n <NAME>)

addrule

Add new rule to selected policy

addtag

Add auto-assignment tag (-g <GUID> | -n <NAME>) -t <TYPE> -a <TAG>

update

Modify policy name (-g <GUID> | -n <NAME>) -n <NAME>

removerule

Remove rules from policy (-g <GUID> | -n <NAME>) -r <RULE_GUID>,…​,<RULE_GUID>

removetag

Remove auto-assignment tag (-g <GUID> | -n <NAME>) -t <RETENTION_DAYS> -a <TAG>

unassign

Unassign VMs from the policy <VM_GUID>,…​,<VM_GUID>

assign

Assign VMs to the policy (-g <POLICY_GUID> | -n <POLICY_NAME>) -v <VM_GUID>,…​,<VM_GUID>

full

Run full backup for selected policy

inc

Run incremental backup for selected policy

addbd

Add second backup destination to selected policy

vc-ve-backup-policies-removerule

Name

vc-ve-backup-policies-removerule - Remove rules from policy (-g | -n ) -r ,...,

Synopsis

vc ve backup policies removerule -r=<rule>[,<rule>…​] [-r=<rule>[, <rule>…​]]…​ (-g=<guid> | -n=<name>)

Description

Remove rules from policy (-g <GUID> | -n <NAME>) -r <RULE_GUID>,…​,<RULE_GUID>

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-r, rule**=<rule>[,<rule>*…​] <GUID>,…​,<GUID> (no spaces)

vc-ve-backup-policies-removetag

Name

vc-ve-backup-policies-removetag - Remove auto-assignment tag (-g | -n ) -t -a

Synopsis

vc ve backup policies removetag -a=<tag> -t=<type> (-g=<guid> | -n=<name>)

Description

Remove auto-assignment tag (-g <GUID> | -n <NAME>) -t <RETENTION_DAYS> -a <TAG>

Options

-g, guid=<guid>

Policy guid

-n, name=<name>

Policy name

-t, type**=<type>*

Types: INCLUDE, EXCLUDE

-a, tag**=<tag>*

vc-ve-backup-policies-set-activation

Name

vc-ve-backup-policies-set-activation - Set policy's activation state (-g | -n ) -a

Synopsis

vc ve backup policies set activation -a=<active> (-g=<guid> | -n=<name>)

Description

Set policy’s activation state (-g <GUID> | -n <NAME>) -a <YES | NO>

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-a, active=<active> YES or NO

vc-ve-backup-policies-set-fail

Name

vc-ve-backup-policies-set-fail - Fails rest of the backup tasks (-g | -n ) -t -a -p

Synopsis

vc ve backup policies set fail -a=<active> -p=<percent> -t=<exportOrStore> (-g=<guid> | -n=<name>)

Description

Fails rest of the backup tasks (-g <GUID> | -n <NAME>) -t <TYPE> -a <ACTIVE> -p <PERCENT>

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-t, type**=<exportOrStore>* Type: STORE, EXPORT

-a, active=<active> Active fail rest of the backup (YES or NO)

-p, percent**=<percent>* Percent of already failed tasks

vc-ve-backup-policies-set-keep

Name

vc-ve-backup-policies-set-keep - Keep last backup when source still exists

Synopsis

vc ve backup policies set keep -k=<keep> -r=<ruleGuid> (-g=<guid> | -n=<name>)

Description

Keep last backup when source still exists

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-r, rule**=<ruleGuid>* Rule GUID

-k, keep**=<keep>* Keep last backup when source still exists? (YES or NO)

vc-ve-backup-policies-set

Name

vc-ve-backup-policies-set - Set recovery plan policies and rules

Synopsis

vc ve backup policies set [COMMAND]

Description

Set recovery plan policies and rules

Commands

activation

Set policy’s activation state (-g <GUID> | -n <NAME>) -a <YES | NO>

removal

Set auto-removal of non-present VMs flag (-g <GUID> | -n <NAME>) -a <YES | NO>

mode

Set auto-assignment mode (-g <GUID> | -n <NAME>) -m <MODE>

priority

Set policy’s backup task priority (-g <GUID> | -n <NAME>) -p <PRIORITY>

fail

Fails rest of the backup tasks (-g <GUID> | -n <NAME>) -t <TYPE> -a <ACTIVE> -p <PERCENT>

keep

Keep last backup when source still exists

vc-ve-backup-policies-set-mode

Name

vc-ve-backup-policies-set-mode - Set auto-assignment mode (-g | -n ) -m

Synopsis

vc ve backup policies set mode -m=<mode> (-g=<guid> | -n=<name>)

Description

Set auto-assignment mode (-g <GUID> | -n <NAME>) -m <MODE>

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-m, mode**=<mode>* Modes: DISABLED, ASSIGN_ONLY, ASSIGN_AND_REMOVE

vc-ve-backup-policies-set-priority

Name

vc-ve-backup-policies-set-priority - Set policy's backup task priority (-g | -n ) -p

Synopsis

vc ve backup policies set priority -p=<priority> (-g=<guid> | -n=<name>)

Description

Set policy’s backup task priority (-g <GUID> | -n <NAME>) -p <PRIORITY>

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-p, priority**=<priority>* Range: 0-100 (50 default)

vc-ve-backup-policies-set-removal

Name

vc-ve-backup-policies-set-removal - Set auto-removal of non-present VMs flag (-g | -n ) -a

Synopsis

vc ve backup policies set removal -a=<auto> (-g=<guid> | -n=<name>)

Description

Set auto-removal of non-present VMs flag (-g <GUID> | -n <NAME>) -a <YES | NO>

Options

-g, guid=<guid> Policy guid

-n, name=<name> Policy name

-a, auto**=<auto>* YES or NO

vc-ve-backup-policies-unassign

Name

vc-ve-backup-policies-unassign - Unassign VMs from the policy ,...,

Synopsis

vc ve backup policies unassign [<guids>[,<guids>…​]…​]

Description

Unassign VMs from the policy <VM_GUID>,…​,<VM_GUID>

Arguments

[<guids>[,<guids>…​]…​] <GUID>,…​,<GUID> (no spaces)

vc-ve-backup-policies-update

Name

vc-ve-backup-policies-update - Modify policy name (-g | -n ) -n

Synopsis

vc ve backup policies update -n=<name> (-p=<guid> | -pn=<name>)

Description

Modify policy name (-g <GUID> | -n <NAME>) -n <NAME>

Options

-p, guid=<guid>

Policy guid

-pn,policy-name=<name>

Policy name

-n, name=<name>

vc-ve-backup-schedule-active

Name

vc-ve-backup-schedule-active - Set schedule to be active (YES or NO) -g -a

Synopsis

vc ve 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

vc-ve-backup-schedule-add

Name

vc-ve-backup-schedule-add - Add policy to schedule

Synopsis

vc ve backup schedule add (-s=<guid> | -sn=<name>) (-p=<guid> | -pn=<name>)

Description

Add policy to schedule

Options

-s, sched-guid=<guid> Schedule guid

-sn,sched-name=<name> Schedule name

-p, policy-guid=<guid> Policy guid

-pn,policy-name=<name> Policy name

vc-ve-backup-schedule-create

Name

vc-ve-backup-schedule-create - Create new schedule

Synopsis

vc ve 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

vc-ve-backup-schedule-delete

Name

vc-ve-backup-schedule-delete - Delete schedule

Synopsis

vc ve backup schedule delete (-pg=<policyGuid> | -pn=<policyName>)

Description

Delete schedule <GUID>

Options

-pg,policy-guid=<policyGuid> VM backup policy guid

-pn,policy-name=<policyName> VM backup policy name

vc-ve-backup-schedule-details

Name

vc-ve-backup-schedule-details - Show schedule details

Synopsis

vc ve backup schedule details <guid>

Description

Show schedule details <GUID>

Arguments

<guid>

vc-ve-backup-schedule-list

Name

vc-ve-backup-schedule-list - List Backup SLAs schedules

Synopsis

vc ve backup schedule list [-h=<noHeaders>]

Description

List Backup SLAs schedules

Options

-h, no-headers=<noHeaders>

vc-ve-backup-schedule

Name

vc-ve-backup-schedule - Policy schedules

Synopsis

vc ve backup schedule [COMMAND]

Description

Policy schedules

Commands

list

List Backup SLAs schedules

create

Create new schedule

update

Update schedule

delete

Delete schedule <GUID>

details

Show schedule details <GUID>

active

Set schedule to be active (YES or NO) -g <GUID> -a <ACTIVE>

add

Add policy to schedule

vc-ve-backup-schedule-update

Name

vc-ve-backup-schedule-update - Update schedule

Synopsis

vc ve backup schedule update -b=<backupType> -d=<duration> -g=<guid> -n=<name> -se=<scheduleExecutionType> -t=<time> -dw=<daysOfWeek> [-dw=<daysOfWeek>]…​ -m=<months> [-m=<months>]…​ -o=<occurrence> [-o=<occurrence>]…​

Description

Update schedule

Options

-g, guid=<guid> -n, name=<name> -b, backup-type=<backupType> Types: FULL, INCREMENTAL, SYNTHETIC, SYNCHRONIZATION

-se,exec-type=<scheduleExecutionType> Schedule exec type. Types: TIME, INTERVAL

-t, time=<time> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR>

-d, duration=<duration> <DURATION | INTERVAL_FREQUENCY>

-dw,days-of-week=<daysOfWeek> <EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY>

-o, occurrence=<occurrence> <ANY, FIRST_IN_MONTH, SECOND_IN_MONTH, THIRD_IN_MONTH, FOURTH_IN_MONTH, LAST_IN_MONTH>

-m, months=<months> <ANY, JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER>

vc-ve-inf-hc-delete

Name

vc-ve-inf-hc-delete - Delete Hypervisor Cluster (-cg | -cn )

Synopsis

vc ve inf hc delete (-cg=<guid> | -cn=<name>)

Description

Delete Hypervisor Cluster (-cg <CLUSTER_GUID> | -cn <CLUSTER_NAME>)

Options

-cg,hypervisor-cluster-guid=<guid> Hypervisor cluster guid

-cn,hypervisor-cluster-name=<name> Hypervisor cluster name

vc-ve-inf-hc-list

Name

vc-ve-inf-hc-list - List Hypervisor Clusters

Synopsis

vc ve inf hc list [-h=<noHeaders>]

Description

List Hypervisor Clusters

Options

-h, no-headers=<noHeaders>

vc-ve-inf-hc

Name

vc-ve-inf-hc - Hypervisor Cluster management

Synopsis

vc ve inf hc [COMMAND]

Description

Hypervisor Cluster management

Commands

delete

Delete Hypervisor Cluster (-cg <CLUSTER_GUID> | -cn <CLUSTER_NAME>)

list

List Hypervisor Clusters

name

Change Hypervisor Cluster name (-cg <CLUSTER_GUID> | -cn <CLUSTER_NAME>) -n <NAME>

vc-ve-inf-hc-name

Name

vc-ve-inf-hc-name - Change Hypervisor Cluster name (-cg | -cn ) -n

Synopsis

vc ve inf hc name -n=<name> (-cg=<guid> | -cn=<name>)

Description

Change Hypervisor Cluster name (-cg <CLUSTER_GUID> | -cn <CLUSTER_NAME>) -n <NAME>

Options

-cg,hypervisor-cluster-guid=<guid>

Hypervisor cluster guid

-cn,hypervisor-cluster-name=<name>

Hypervisor cluster name

-n, name=<name>

vc-ve-inf-hv-create

Name

vc-ve-inf-hv-create - Create new Hypervisor Manager -u -t

Synopsis

vc ve inf hv create -t=<type> -u=<url>

Description

Create new Hypervisor Manager -u <URL | ACCOUNT_ID> -t <TYPE>

Options

-u, url=<url>

-t, type**=<type>*

vc-ve-inf-hv-delete

Name

vc-ve-inf-hv-delete - Delete Hypervisor (-hg | -hn )

Synopsis

vc ve inf hv delete (-hg=<guid> | -hn=<name>)

Description

Delete Hypervisor (-hg <GUID> | -hn <NAME>)

Options

-hg,hypervisor-guid=<guid> Hypervisor guid

-hn,hypervisor-name=<name> Hypervisor name

vc-ve-inf-hv-details

Name

vc-ve-inf-hv-details - Hypervisor details (-hg | -hn )

Synopsis

vc ve inf hv details (-hg=<guid> | -hn=<name>)

Description

Hypervisor details (-hg <GUID> | -hn <NAME>)

Options

-hg,hypervisor-guid=<guid> Hypervisor guid

-hn,hypervisor-name=<name> Hypervisor name

vc-ve-inf-hv-host

Name

vc-ve-inf-hv-host - Change host (-hg | -hn ) -u

Synopsis

vc ve inf hv host -h=<host> (-hg=<guid> | -hn=<name>)

Description

Change host (-hg <GUID> | -hn <NAME>) -u <NEW_HOST>

Options

-hg,hypervisor-guid=<guid>

Hypervisor guid

-hn,hypervisor-name=<name>

Hypervisor name

-h, host**=<host>*

vc-ve-inf-hv-list

Name

vc-ve-inf-hv-list - Hypervisors list

Synopsis

vc ve inf hv list [-h=<noHeaders>]

Description

Hypervisors list

Options

-h, no-headers=<noHeaders>

vc-ve-inf-hv-listvm

Name

vc-ve-inf-hv-listvm - Virtual Machines list of hypervisor (-hg | -hn )

Synopsis

vc ve inf hv listvm (-hg=<guid> | -hn=<name>)

Description

Virtual Machines list of hypervisor (-hg <GUID> | -hn <NAME>)

Options

-hg,hypervisor-guid=<guid> Hypervisor guid

-hn,hypervisor-name=<name> Hypervisor name

vc-ve-inf-hvm-create

Name

vc-ve-inf-hvm-create - Hypervisor Manager create commands

Synopsis

vc ve inf hvm create [COMMAND]

Description

Hypervisor Manager create commands

Commands

rhev

Create new Rhev Hypervisor Manager -u <URL | ACCOUNT_ID> -us <USER_NAME> -p <PASSWORD>

vc-ve-inf-hvm-create-rhev

Name

vc-ve-inf-hvm-create-rhev - Create new Rhev Hypervisor Manager -u -us -p

Synopsis

vc ve inf hvm create rhev -p=<password> -u=<url> -us=<userName>

Description

Create new Rhev Hypervisor Manager -u <URL | ACCOUNT_ID> -us <USER_NAME> -p <PASSWORD>

Options

-u, url=<url>

-us,user-name=<userName>

-p, password=<password>

vc-ve-inf-hv

Name

vc-ve-inf-hv - Hypervisor management

Synopsis

vc ve inf hv [COMMAND]

Description

Hypervisor management

Commands

create

Create new Hypervisor Manager -u <URL | ACCOUNT_ID> -t <TYPE>

delete

Delete Hypervisor (-hg <GUID> | -hn <NAME>)

list

Hypervisors list

details

Hypervisor details (-hg <GUID> | -hn <NAME>)

host

Change host (-hg <GUID> | -hn <NAME>) -u <NEW_HOST>

listvm

Virtual Machines list of hypervisor (-hg <GUID> | -hn <NAME>)

sync

Synchronize inventory with hypervisor (-hg <GUID> | -hn <NAME>)

set

set recovery plan policies and rules

vc-ve-inf-hvm-delete

Name

vc-ve-inf-hvm-delete - Delete Hypervisor Manager (-hg | -hn )

Synopsis

vc ve inf hvm delete (-hg=<guid> | -hn=<name>)

Description

Delete Hypervisor Manager (-hg <GUID> | -hn <HOST>)

Options

-hg,hypervisor-manager-guid=<guid> Hypervisor manager guid

-hn,hypervisor-manager-name=<name> Hypervisor manager name

vc-ve-inf-hvm-details

Name

vc-ve-inf-hvm-details - Hypervisor Manager details (-hg | -hn )

Synopsis

vc ve inf hvm details (-hg=<guid> | -hn=<name>)

Description

Hypervisor Manager details (-hg <GUID> | -hn <HOST>)

Options

-hg,hypervisor-manager-guid=<guid> Hypervisor manager guid

-hn,hypervisor-manager-name=<name> Hypervisor manager name

vc-ve-inf-hvm-host

Name

vc-ve-inf-hvm-host - Change host (-hg | -hn ) -h

Synopsis

vc ve inf hvm host -h=<host> (-hg=<guid> | -hn=<name>)

Description

Change host (-hg <GUID> | -hn <HOST>) -h <NEW_HOST>

Options

-hg,hypervisor-manager-guid=<guid>

Hypervisor manager guid

-hn,hypervisor-manager-name=<name>

Hypervisor manager name

-h, host**=<host>*

vc-ve-inf-hvm-listhv

Name

vc-ve-inf-hvm-listhv - List hypervisors managed by hypervisor manager (-hg | -hn )

Synopsis

vc ve inf hvm listhv (-hg=<guid> | -hn=<name>)

Description

List hypervisors managed by hypervisor manager (-hg <GUID> | -hn <HOST>)

Options

-hg,hypervisor-manager-guid=<guid> Hypervisor manager guid

-hn,hypervisor-manager-name=<name> Hypervisor manager name

vc-ve-inf-hvm-list

Name

vc-ve-inf-hvm-list - Hypervisor Managers list

Synopsis

vc ve inf hvm list [-h=<noHeaders>]

Description

Hypervisor Managers list

Options

-h, no-headers=<noHeaders>

vc-ve-inf-hvm-listvm

Name

vc-ve-inf-hvm-listvm - Virtual Machines list of hypervisor manager (-hg | -hn )

Synopsis

vc ve inf hvm listvm (-hg=<guid> | -hn=<name>)

Description

Virtual Machines list of hypervisor manager (-hg <GUID> | -hn <HOST>)

Options

-hg,hypervisor-manager-guid=<guid> Hypervisor manager guid

-hn,hypervisor-manager-name=<name> Hypervisor manager name

vc-ve-inf-hvm

Name

vc-ve-inf-hvm - Hypervisor Manager management

Synopsis

vc ve inf hvm [COMMAND]

Description

Hypervisor Manager management

Commands

create

Hypervisor Manager create commands

delete

Delete Hypervisor Manager (-hg <GUID> | -hn <HOST>)

list

Hypervisor Managers list

listvm

Virtual Machines list of hypervisor manager (-hg <GUID> | -hn <HOST>)

details

Hypervisor Manager details (-hg <GUID> | -hn <HOST>)

listhv

List hypervisors managed by hypervisor manager (-hg <GUID> | -hn <HOST>)

sync

Index inventory on hypervisor manager (-hg <GUID> | -hn <HOST>)

host

Change host (-hg <GUID> | -hn <HOST>) -h <NEW_HOST>

update

Hypervisor manager update (-hg <GUID> | -hn <HOST>) -i <PROPERTY_NUMBER> -v <VALUE>

set

set recovery plan policies and rules

vc-ve-inf-hvm-set-credentials

Name

vc-ve-inf-hvm-set-credentials - Set user/password or access key/secret key -g -u -p

Synopsis

vc ve inf hvm set credentials -p=<password> -u=<user> (-hg=<guid> | -hn=<name>)

Description

Set user/password or access key/secret key -g <GUID | HOST> -u <USER/ACCESS_KEY> -p <PASSWORD/SECRET_KEY>

Options

-hg,hypervisor-manager-guid=<guid>

Hypervisor manager guid

-hn,hypervisor-manager-name=<name>

Hypervisor manager name

-u, user=<user>

-p, password=<password>

vc-ve-inf-hvm-set-endpoint

Name

vc-ve-inf-hvm-set-endpoint - Set endpoint interface type for HV manager (-hg | -hn ) -t

Synopsis

vc ve inf hvm set endpoint -t=<type> (-hg=<guid> | -hn=<name>)

Description

Set endpoint interface type for HV manager (-hg <GUID> | -hn <HOST>) -t <INTERFACE_TYPE>

Options

-hg,hypervisor-manager-guid=<guid>

Hypervisor manager guid

-hn,hypervisor-manager-name=<name>

Hypervisor manager name

-t, type**=<type>*

vc-ve-inf-hvm-set

Name

vc-ve-inf-hvm-set - set recovery plan policies and rules

Synopsis

vc ve inf hvm set [COMMAND]

Description

set recovery plan policies and rules

Commands

credentials

Set user/password or access key/secret key -g <GUID | HOST> -u <USER/ACCESS_KEY> -p <PASSWORD/SECRET_KEY>

ssh

Set SSH key path (-hg <GUID> | -hn <HOST>) )-p <SSH_KEYPATH>

nc

Set node configuration for hypervisor (-hg <GUID> | -hn <HOST>) (-ncg <NODE_CONFIG_GUID> | -ncn <NODE_CONFIG_NAME>

mode

Set export/import mode for hypervisor (-hg <GUID> | -hn <HOST>) -m <MODE>

region

Set region for HV manager (-hg <GUID> | -hn <HOST>) -r <REGION>

endpoint

Set endpoint interface type for HV manager (-hg <GUID> | -hn <HOST>) -t <INTERFACE_TYPE>

vc-ve-inf-hvm-set-mode

Name

vc-ve-inf-hvm-set-mode - Set export/import mode for hypervisor (-hg | -hn ) -m

Synopsis

vc ve inf hvm set mode -m=<mode> (-hg=<guid> | -hn=<name>)

Description

Set export/import mode for hypervisor (-hg <GUID> | -hn <HOST>) -m <MODE>

Options

-hg,hypervisor-manager-guid=<guid>

Hypervisor manager guid

-hn,hypervisor-manager-name=<name>

Hypervisor manager name

-m, mode**=<mode>*

vc-ve-inf-hvm-set-nc

Name

vc-ve-inf-hvm-set-nc - Set node configuration for hypervisor (-hg | -hn ) (-ncg | -ncn

Synopsis

vc ve inf hvm set nc (-hg=<guid> | -hn=<name>) (-ncg=<guid> | -ncn=<name>)

Description

Set node configuration for hypervisor (-hg <GUID> | -hn <HOST>) (-ncg <NODE_CONFIG_GUID> | -ncn <NODE_CONFIG_NAME>

Options

-hg,hypervisor-manager-guid=<guid> Hypervisor manager guid

-hn,hypervisor-manager-name=<name> Hypervisor manager name

-ncg,node-config-guid=<guid> Node config guid

-ncn,node-config-name=<name> Node config name

vc-ve-inf-hvm-set-region

Name

vc-ve-inf-hvm-set-region - Set region for HV manager (-hg | -hn ) -r

Synopsis

vc ve inf hvm set region -r=<region> (-hg=<guid> | -hn=<name>)

Description

Set region for HV manager (-hg <GUID> | -hn <HOST>) -r <REGION>

Options

-hg,hypervisor-manager-guid=<guid>

Hypervisor manager guid

-hn,hypervisor-manager-name=<name>

Hypervisor manager name

-r, region**=<region>*

vc-ve-inf-hvm-set-ssh

Name

vc-ve-inf-hvm-set-ssh - Set SSH key path (-hg | -hn ) )-p

Synopsis

vc ve inf hvm set ssh -p=<keyPath> (-hg=<guid> | -hn=<name>)

Description

Set SSH key path (-hg <GUID> | -hn <HOST>) )-p <SSH_KEYPATH>

Options

-hg,hypervisor-manager-guid=<guid>

Hypervisor manager guid

-hn,hypervisor-manager-name=<name>

Hypervisor manager name

-p, path=<keyPath>

vc-ve-inf-hvm-sync

Name

vc-ve-inf-hvm-sync - Index inventory on hypervisor manager (-hg | -hn )

Synopsis

vc ve inf hvm sync (-hg=<guid> | -hn=<name>)

Description

Index inventory on hypervisor manager (-hg <GUID> | -hn <HOST>)

Options

-hg,hypervisor-manager-guid=<guid> Hypervisor manager guid

-hn,hypervisor-manager-name=<name> Hypervisor manager name

vc-ve-inf-hvm-update

Name

vc-ve-inf-hvm-update - Hypervisor manager update (-hg | -hn ) -i -v

Synopsis

vc ve inf hvm update [-n=<number>] [-v=<value>] (-hg=<guid> | -hn=<name>)

Description

Hypervisor manager update (-hg <GUID> | -hn <HOST>) -i <PROPERTY_NUMBER> -v <VALUE>

Options

-hg,hypervisor-manager-guid=<guid>

Hypervisor manager guid

-hn,hypervisor-manager-name=<name>

Hypervisor manager name

-n, property-number**=<number>*

-v, value**=<value>*

vc-ve-inf-hvs-delete

Name

vc-ve-inf-hvs-delete - Delete Hypervisor Storage -gh | -hn

Synopsis

vc ve inf hvs delete (-hg=<guid> | -hn=<name>)

Description

Delete Hypervisor Storage -gh <GUID> | -hn <NAME>

Options

-hg,hypervisor-storage-guid=<guid> Hypervisor storage guid

-hn,hypervisor-storage-name=<name> Hypervisor storage name

vc-ve-inf-hv-set-cluster

Name

vc-ve-inf-hv-set-cluster - Set user/password (-hg | -hn ) (-cg | -cn )

Synopsis

vc ve inf hv set cluster (-hg=<guid> | -hn=<name>) (-cg=<guid> | -cn=<name>)

Description

Set user/password (-hg <GUID> | -hn <NAME>) (-cg <CLUSTER_GUID> | -cn <CLUSTER_NAME>)

Options

-hg,hypervisor-guid=<guid> Hypervisor guid

-hn,hypervisor-name=<name> Hypervisor name

-cg,hypervisor-cluster-guid=<guid> Hypervisor cluster guid

-cn,hypervisor-cluster-name=<name> Hypervisor cluster name

vc-ve-inf-hv-set-credentials

Name

vc-ve-inf-hv-set-credentials - Set user/password (-hg | -hn ) -u -p

Synopsis

vc ve inf hv set credentials -p=<password> -u=<user> (-hg=<guid> | -hn=<name>)

Description

Set user/password (-hg <GUID> | -hn <NAME>) -u <USER> -p <PASSWORD>

Options

-hg,hypervisor-guid=<guid>

Hypervisor guid

-hn,hypervisor-name=<name>

Hypervisor name

-u, user=<user>

-p, password=<password>

vc-ve-inf-hv-set

Name

vc-ve-inf-hv-set - set recovery plan policies and rules

Synopsis

vc ve inf hv set [COMMAND]

Description

set recovery plan policies and rules

Commands

credentials

Set user/password (-hg <GUID> | -hn <NAME>) -u <USER> -p <PASSWORD>

ssh

Set SSH key path -g <GUID | HOST> -p <SSH_KEYPATH>

nc

Set node configuration for hypervisor (-hg <GUID> | -hn <NAME>) (-ncg <NODE_CONFIG_GUID> | -ncn <NODE_CONFIG_NAME>)

mode

Set export/import mode for hypervisor (-hg <GUID> | -hn <NAME>) -m <MODE>

user

Set user/password (-hg <GUID> | -hn <NAME>) -u <USERNAME>

nic

Set user/password (-hg <GUID> | -hn <NAME>) -a <NIC_ADDRESS>

cluster

Set user/password (-hg <GUID> | -hn <NAME>) (-cg <CLUSTER_GUID> | -cn <CLUSTER_NAME>)

vc-ve-inf-hv-set-mode

Name

vc-ve-inf-hv-set-mode - Set export/import mode for hypervisor (-hg | -hn ) -m

Synopsis

vc ve inf hv set mode -u=<mode> (-hg=<guid> | -hn=<name>)

Description

Set export/import mode for hypervisor (-hg <GUID> | -hn <NAME>) -m <MODE>

Options

-hg,hypervisor-guid=<guid> Hypervisor guid

-hn,hypervisor-name=<name> Hypervisor name

-u, mode**=<mode>* Modes: VM_IMAGE_PLUS_INCREMENTAL_DISKS, CHANGED_BLOCK_TRACKING

vc-ve-inf-hv-set-nc

Name

vc-ve-inf-hv-set-nc - Set node configuration for hypervisor (-hg | -hn ) (-ncg | -ncn )

Synopsis

vc ve inf hv set nc (-hg=<guid> | -hn=<name>) (-ncg=<guid> | -ncn=<name>)

Description

Set node configuration for hypervisor (-hg <GUID> | -hn <NAME>) (-ncg <NODE_CONFIG_GUID> | -ncn <NODE_CONFIG_NAME>)

Options

-hg,hypervisor-guid=<guid> Hypervisor guid

-hn,hypervisor-name=<name> Hypervisor name

-ncg,node-config-guid=<guid> Node config guid

-ncn,node-config-name=<name> Node config name

vc-ve-inf-hv-set-nic

Name

vc-ve-inf-hv-set-nic - Set user/password (-hg | -hn ) -a

Synopsis

vc ve inf hv set nic -a=<address> (-hg=<guid> | -hn=<name>)

Description

Set user/password (-hg <GUID> | -hn <NAME>) -a <NIC_ADDRESS>

Options

-hg,hypervisor-guid=<guid>

Hypervisor guid

-hn,hypervisor-name=<name>

Hypervisor name

-a, address**=<address>*

vc-ve-inf-hv-set-ssh

Name

vc-ve-inf-hv-set-ssh - Set SSH key path -g -p

Synopsis

vc ve inf hv set ssh -p=<keyPath> (-hg=<guid> | -hn=<name>)

Description

Set SSH key path -g <GUID | HOST> -p <SSH_KEYPATH>

Options

-hg,hypervisor-guid=<guid>

Hypervisor guid

-hn,hypervisor-name=<name>

Hypervisor name

-p, keypath**=<keyPath>*

vc-ve-inf-hv-set-user

Name

vc-ve-inf-hv-set-user - Set user/password (-hg | -hn ) -u

Synopsis

vc ve inf hv set user -u=<username> (-hg=<guid> | -hn=<name>)

Description

Set user/password (-hg <GUID> | -hn <NAME>) -u <USERNAME>

Options

-hg,hypervisor-guid=<guid>

Hypervisor guid

-hn,hypervisor-name=<name>

Hypervisor name

-u, username**=<username>*

vc-ve-inf-hvs-list

Name

vc-ve-inf-hvs-list - List Hypervisor Storages

Synopsis

vc ve inf hvs list [-h=<noHeaders>]

Description

List Hypervisor Storages

Options

-h, no-headers=<noHeaders>

vc-ve-inf-hvs

Name

vc-ve-inf-hvs - Hypervisor Storage management

Synopsis

vc ve inf hvs [COMMAND]

Description

Hypervisor Storage management

Commands

delete

Delete Hypervisor Storage -gh <GUID> | -hn <NAME>

list

List Hypervisor Storages

pool

Set Hypervisor Storage Pool Name (-hg <GUID> | -hn <NAME>) -n <STORAGE_POOL_NAME>

vc-ve-inf-hvs-pool

Name

vc-ve-inf-hvs-pool - Set Hypervisor Storage Pool Name (-hg | -hn ) -n

Synopsis

vc ve inf hvs pool -n=<poolName> (-hg=<guid> | -hn=<name>)

Description

Set Hypervisor Storage Pool Name (-hg <GUID> | -hn <NAME>) -n <STORAGE_POOL_NAME>

Options

-hg,hypervisor-storage-guid=<guid> Hypervisor storage guid

-hn,hypervisor-storage-name=<name> Hypervisor storage name

-n, name=<poolName> Storage Pool name

vc-ve-inf-hv-sync

Name

vc-ve-inf-hv-sync - Synchronize inventory with hypervisor (-hg | -hn )

Synopsis

vc ve inf hv sync (-hg=<guid> | -hn=<name>)

Description

Synchronize inventory with hypervisor (-hg <GUID> | -hn <NAME>)

Options

-hg,hypervisor-guid=<guid> Hypervisor guid

-hn,hypervisor-name=<name> Hypervisor name

vc-ve-inf

Name

vc-ve-inf - Infrastructure

Synopsis

vc ve inf [COMMAND]

Description

Infrastructure

Commands

hvm

Hypervisor Manager management

hv

Hypervisor management

hc

Hypervisor Cluster management

hvs

Hypervisor Storage management

network

Network management

project

Project management

nwic

Network Interface Card management

quota

Quota management

vc-ve-inf-network-details

Name

vc-ve-inf-network-details - Network details -g -n

Synopsis

vc ve inf network details (-g=<guid> | -n=<name>)

Description

Network details -g <GUID> -n <NAME>

Options

-g, network-guid**=<guid>* Hypervisor manager guid

-n, network-name**=<name>* Hypervisor manager name

vc-ve-inf-network-list

Name

vc-ve-inf-network-list - Networks list

Synopsis

vc ve inf network list [-h=<noHeaders>]

Description

Networks list

Options

-h, no-headers=<noHeaders>

vc-ve-inf-network

Name

vc-ve-inf-network - Network management

Synopsis

vc ve inf network [COMMAND]

Description

Network management

Commands

list

Networks list

details

Network details -g <GUID> -n <NAME>

vc-ve-inf-nwic-details

Name

vc-ve-inf-nwic-details - Network interface card details -g | -n

Synopsis

vc ve inf nwic details (-g=<guid> | -n=<name>)

Description

Network interface card details -g <GUID> | -n <NAME>

Options

-g, network-guid**=<guid>* Hypervisor manager guid

-n, network-name**=<name>* Hypervisor manager name

vc-ve-inf-nwic-list

Name

vc-ve-inf-nwic-list - Networks interfaces cards list

Synopsis

vc ve inf nwic list [-h=<noHeaders>]

Description

Networks interfaces cards list

Options

-h, no-headers=<noHeaders>

vc-ve-inf-nwic

Name

vc-ve-inf-nwic - Network Interface Card management

Synopsis

vc ve inf nwic [COMMAND]

Description

Network Interface Card management

Commands

list

Networks interfaces cards list

details

Network interface card details -g <GUID> | -n <NAME>

vc-ve-inf-project-details

Name

vc-ve-inf-project-details - Project details -g | -n

Synopsis

vc ve inf project details (-pg=<guid> | -pn=<name>)

Description

Project details -g <GUID> | -n <NAME>

Options

-pg,project-guid=<guid> Project guid

-pn,project-name=<name> Project name

vc-ve-inf-project-list

Name

vc-ve-inf-project-list - Projects list

Synopsis

vc ve inf project list [-h=<noHeaders>]

Description

Projects list

Options

-h, no-headers=<noHeaders>

vc-ve-inf-project

Name

vc-ve-inf-project - Project management

Synopsis

vc ve inf project [COMMAND]

Description

Project management

Commands

list

Projects list

details

Project details -g <GUID> | -n <NAME>

quota

Set Project Quota (-pg <PROJECT_GUID> | -pn <PROJECT_NAME>) (-qg <QUOTA_GUID> | -qn <QUOTA_NAME>)

vc-ve-inf-project-quota

Name

vc-ve-inf-project-quota - Set Project Quota (-pg | -pn ) (-qg | -qn )

Synopsis

vc ve inf project quota (-pg=<guid> | -pn=<name>) (-qg=<guid> | -qn=<name>)

Description

Set Project Quota (-pg <PROJECT_GUID> | -pn <PROJECT_NAME>) (-qg <QUOTA_GUID> | -qn <QUOTA_NAME>)

Options

-pg,project-guid=<guid> Project guid

-pn,project-name=<name> Project name

-qg,quota-guid=<guid> Quota guid

-qn,quota-name=<name> Quota name

vc-ve-inf-quota-active

Name

vc-ve-inf-quota-active - Change Quota active state (-qg | -qn ) -a

Synopsis

vc ve inf quota active -a=<active> (-qg=<guid> | -qn=<name>)

Description

Change Quota active state (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -a <ACTIVE>

Options

-qg,quota-guid=<guid> Quota guid

-qn,quota-name=<name> Quota name

-a, active=<active> Yes or NO

vc-ve-inf-quota-create

Name

vc-ve-inf-quota-create - Create Quota

Synopsis

vc ve inf quota create <name>

Description

Create Quota <NAME>

Arguments

<name>

vc-ve-inf-quota-delete

Name

vc-ve-inf-quota-delete - Delete Quota (-qg | -qn )

Synopsis

vc ve inf quota delete (-qg=<guid> | -qn=<name>)

Description

Delete Quota (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>)

Options

-qg,quota-guid=<guid> Quota guid

-qn,quota-name=<name> Quota name

vc-ve-inf-quota-details

Name

vc-ve-inf-quota-details - Quota details (-qg | -qn )

Synopsis

vc ve inf quota details (-qg=<guid> | -qn=<name>)

Description

Quota details (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>)

Options

-qg,quota-guid=<guid> Quota guid

-qn,quota-name=<name> Quota name

vc-ve-inf-quota-list

Name

vc-ve-inf-quota-list - List Quotas

Synopsis

vc ve inf quota list [-h=<noHeaders>]

Description

List Quotas

Options

-h, no-headers=<noHeaders>

vc-ve-inf-quota

Name

vc-ve-inf-quota - Quota management

Synopsis

vc ve inf quota [COMMAND]

Description

Quota management

Commands

create

Create Quota <NAME>

delete

Delete Quota (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>)

details

Quota details (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>)

list

List Quotas

projects

List Projects for Quotas (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>)

active

Change Quota active state (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -a <ACTIVE>

name

Change Quota name (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -n <NAME>

rule

Rule recovery plan policies and rules

vc-ve-inf-quota-name

Name

vc-ve-inf-quota-name - Change Quota name (-qg | -qn ) -n

Synopsis

vc ve inf quota name -n=<name> (-qg=<guid> | -qn=<name>)

Description

Change Quota name (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -n <NAME>

Options

-qg,quota-guid=<guid>

Quota guid

-qn,quota-name=<name>

Quota name

-n, name=<name>

vc-ve-inf-quota-projects

Name

vc-ve-inf-quota-projects - List Projects for Quotas (-qg | -qn )

Synopsis

vc ve inf quota projects (-qg=<guid> | -qn=<name>)

Description

List Projects for Quotas (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>)

Options

-qg,quota-guid=<guid> Quota guid

-qn,quota-name=<name> Quota name

vc-ve-inf-quota-rule-add

Name

vc-ve-inf-quota-rule-add - Add Rule to Quota (-qg | -qn ) -n -t -a -hl -ht -s -st

Synopsis

vc ve inf quota rule add -a=<active> -hl=<hardLimit> -ht=<hardLimitTime> -n=<name> -s=<softLimit> -st=<softLimitTime> -t=<type> (-qg=<guid> | -qn=<name>)

Description

Add Rule to Quota (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -n <RULE_NAME> -t <TYPE> -a <ACTIVE> -hl <HARD_LIMIT> -ht <HARD_LIMIT_TIME_FRAME> -s <SOFT_LIMIT> -st <SOFT_LIMIT_TIME_FRAME>

Options

-qg,quota-guid=<guid>

Quota guid

-qn,quota-name=<name>

Quota name

-n, name=<name>

Names

NUMBER_OF_BACKUPS, LOGICAL_BACKUP_CAPACITY, NUMBER_OF_RESTORES

-t, type**=<type>*

Types: TOTAL, PER_INSTANCE

-a, active=<active>

YES or NO

-hl,hard-limit=<hardLimit>

-ht,hard-limit-time=<hardLimitTime>

-s, soft-limit**=<softLimit>*

-st,soft-limit-time=<softLimitTime>

vc-ve-inf-quota-rule-delete

Name

vc-ve-inf-quota-rule-delete - Delete Rule from Quota (-qg | -qn ) -n -t

Synopsis

vc ve inf quota rule delete -n=<name> -t=<type> (-qg=<guid> | -qn=<name>)

Description

Delete Rule from Quota (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -n <RULE_NAME> -t <TYPE>

Options

-qg,quota-guid=<guid>

Quota guid

-qn,quota-name=<name>

Quota name

-n, name=<name>

-t, type**=<type>*

vc-ve-inf-quota-rule-edit

Name

vc-ve-inf-quota-rule-edit - Edit Rule in Quota (-qg | -qn ) -n -t -a -hl -ht -s -st

Synopsis

vc ve inf quota rule edit -a=<active> -hl=<hardLimit> -ht=<hardLimitTime> -n=<name> -s=<softLimit> -st=<softLimitTime> -t=<type> (-qg=<guid> | -qn=<name>)

Description

Edit Rule in Quota (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -n <RULE_NAME> -t <TYPE> -a <ACTIVE> -hl <HARD_LIMIT> -ht <HARD_LIMIT_TIME_FRAME> -s <SOFT_LIMIT> -st <SOFT_LIMIT_TIME_FRAME>

Options

-qg,quota-guid=<guid>

Quota guid

-qn,quota-name=<name>

Quota name

-n, name=<name>

-t, type**=<type>*

-a, active=<active>

YES or NO

-hl,hard-limit=<hardLimit>

-ht,hard-limit-time=<hardLimitTime>

-s, soft-limit**=<softLimit>*

-st,soft-limit-time=<softLimitTime>

vc-ve-inf-quota-rule-list

Name

vc-ve-inf-quota-rule-list - List all possible rule names

Synopsis

vc ve inf quota rule list

Description

List all possible rule names

vc-ve-inf-quota-rule

Name

vc-ve-inf-quota-rule - Rule recovery plan policies and rules

Synopsis

vc ve inf quota rule [COMMAND]

Description

Rule recovery plan policies and rules

Commands

add

Add Rule to Quota (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -n <RULE_NAME> -t <TYPE> -a <ACTIVE> -hl <HARD_LIMIT> -ht <HARD_LIMIT_TIME_FRAME> -s <SOFT_LIMIT> -st <SOFT_LIMIT_TIME_FRAME>

delete

Delete Rule from Quota (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -n <RULE_NAME> -t <TYPE>

edit

Edit Rule in Quota (-qg <GUID_QUOTA> | -qn <QUOTA_NAME>) -n <RULE_NAME> -t <TYPE> -a <ACTIVE> -hl <HARD_LIMIT> -ht <HARD_LIMIT_TIME_FRAME> -s <SOFT_LIMIT> -st <SOFT_LIMIT_TIME_FRAME>

list

List all possible rule names

vc-ve-inst-ackb

Name

vc-ve-inst-ackb - Acknowledge warnings related to the backup -g | -n

Synopsis

vc ve inst ackb (-g=<guid> | -n=<name>)

Description

Acknowledge warnings related to the backup -g<GUID> | -n <NAME>

Options

-g, vm-guid**=<guid>* VM guid

-n, vm-name**=<name>* VM name

vc-ve-inst-ackvm

Name

vc-ve-inst-ackvm - Acknowledge all backup warnings related to the VM -g | -n

Synopsis

vc ve inst ackvm (-g=<guid> | -n=<name>)

Description

Acknowledge all backup warnings related to the VM -g <GUID> | -n <NAME>

Options

-g, vm-guid**=<guid>* VM guid

-n, vm-name**=<name>* VM name

vc-ve-inst-backup

Name

vc-ve-inst-backup - Full backup virtual machine (-g | -n )

Synopsis

vc ve inst backup -p=<priority> -r=<retryCount> (-g=<guid> | -n=<name>)

Description

Full backup virtual machine (-g <GUID> | -n <NAME>)

Options

-g, guid=<guid>

VM guid

-n, name=<name>

VM name

-p, priority**=<priority>*

0-100

-r, retry-count**=<retryCount>*

vc-ve-inst-bdetails

Name

vc-ve-inst-bdetails - Show backup details

Synopsis

vc ve inst bdetails (-g=<guid> | -n=<name>)

Description

Show backup details <BACKUP_GUID>

Options

-g, vm-guid**=<guid>* VM guid

-n, vm-name**=<name>* VM name

vc-ve-inst-delete

Name

vc-ve-inst-delete - Delete virtual machine (-g | -n )

Synopsis

vc ve inst delete (-g=<guid> | -n=<name>)

Description

Delete virtual machine (-g <GUID> | -n <NAME>)

Options

-g, guid=<guid> VM guid

-n, name=<name> VM name

vc-ve-inst-details

Name

vc-ve-inst-details - Show virtual machine details -g | -n

Synopsis

vc ve inst details (-g=<guid> | -n=<name>)

Description

Show virtual machine details -g <VM_GUID> | -n <NAME>

Options

-g, vm-guid**=<guid>* VM guid

-n, vm-name**=<name>* VM name

vc-ve-inst-dnp

Name

vc-ve-inst-dnp - Delete non present Virtual Machines

Synopsis

vc ve inst dnp <uuid>

Description

Delete non present Virtual Machines <UUID>

Arguments

<uuid>

vc-ve-inst-exclude

Name

vc-ve-inst-exclude - Exclude disk from backup excluded (1) / included (0) -g -a <0|1>

Synopsis

vc ve inst exclude -a=<number> -g=<guid>

Description

Exclude disk from backup excluded (1) / included (0) -g <DISK_GUID> -a <0|1>

Options

-g, guid=<guid> -a, active=<number> 0 (disabled) or 1 (enabled)

vc-ve-inst-list-backups

Name

vc-ve-inst-list-backups - List backups of the VM -g | -n

Synopsis

vc ve inst list backups [-h=<noHeaders>] (-g=<guid> | -n=<name>)

Description

List backups of the VM -g <GUID> | -n <NAME>

Options

-g, vm-guid**=<guid>* VM guid

-h, no-headers=<noHeaders> -n, vm-name**=<name>* VM name

vc-ve-inst-list-disks

Name

vc-ve-inst-list-disks - List detected VM disks -g | -n

Synopsis

vc ve inst list disks [-h=<noHeaders>] (-g=<guid> | -n=<name>)

Description

List detected VM disks -g <GUID> | -n <NAME>

Options

-g, vm-guid**=<guid>* VM guid

-h, no-headers=<noHeaders> -n, vm-name**=<name>* VM name

vc-ve-inst-list

Name

vc-ve-inst-list - List commands

Synopsis

vc ve inst list [-h=<noHeaders>] [COMMAND]

Description

List commands

Options

-h, no-headers=<noHeaders>

Commands

disks

List detected VM disks -g <GUID> | -n <NAME>

backups

List backups of the VM -g <GUID> | -n <NAME>

snapshots

List managed VM snapshots -g <GUID> | -n <NAME>

tasks

List tasks related to the VM -g <GUID>

vc-ve-inst-list-snapshots

Name

vc-ve-inst-list-snapshots - List managed VM snapshots -g | -n

Synopsis

vc ve inst list snapshots [-h=<noHeaders>] (-g=<guid> | -n=<name>)

Description

List managed VM snapshots -g <GUID> | -n <NAME>

Options

-g, vm-guid**=<guid>* VM guid

-h, no-headers=<noHeaders> -n, vm-name**=<name>* VM name

vc-ve-inst-list-tasks

Name

vc-ve-inst-list-tasks - List tasks related to the VM -g

Synopsis

vc ve inst list tasks [-h=<noHeaders>] (-g=<guid> | -n=<name>)

Description

List tasks related to the VM -g <GUID>

Options

-g, vm-guid**=<guid>* VM guid

-h, no-headers=<noHeaders> -n, vm-name**=<name>* VM name

vc-ve-inst

Name

vc-ve-inst - Instances

Synopsis

vc ve inst [COMMAND]

Description

Instances

Commands

list

List commands

set

set commands

snapshot

Snapshot recovery plan policies and rules

backup

Full backup virtual machine (-g <GUID> | -n <NAME>)

policy

Assign VM to the policy (-g <GUID> | -n <NAME>) -p <VM_POLICY_GUID>

delete

Delete virtual machine (-g <GUID> | -n <NAME>)

exclude

Exclude disk from backup excluded (1) / included (0) -g <DISK_GUID> -a <0|1>

dnp

Delete non present Virtual Machines <UUID>

details

Show virtual machine details -g <VM_GUID> | -n <NAME>

bdetails

Show backup details <BACKUP_GUID>

ackvm

Acknowledge all backup warnings related to the VM -g <GUID> | -n <NAME>

ackb

Acknowledge warnings related to the backup -g<GUID> | -n <NAME>

vc-ve-inst-policy

Name

vc-ve-inst-policy - Assign VM to the policy (-g | -n ) -p

Synopsis

vc ve inst policy (-g=<guid> | -n=<name>) (-p=<guid> | -pn=<name>)

Description

Assign VM to the policy (-g <GUID> | -n <NAME>) -p <VM_POLICY_GUID>

Options

-g, vm-guid**=<guid>* VM guid

-n, vm-name**=<name>* VM name

-p, policy-guid=<guid> Policy guid

-pn,policy-name=<name> Policy name

vc-ve-inst-set-cmdexec

Name

vc-ve-inst-set-cmdexec - Set pre/post-snapshot CMD exec enabled (1) / disabled (0) -g -a <0|1> -f Synopsis vc ve inst set cmdexec -a= -f= (-g= | -n=)

Description
    Set pre/post-snapshot CMD exec enabled (1) / disabled (0) -g <GUID> -a <0|1> -f <PRE | POST>


Options

-g,vm-guid=<guid>

VM guid

-n,vm-name=<name>

VM name

-a,active=<number>

0 (disabled) or 1 (enabled)

-f,for=<preOrPost>

PRE or POST

vc-ve-inst-set-cmd

Name

vc-ve-inst-set-cmd - Set pre/post-snapshot CMD as semi-colon-separated string (-g | -n ) -f

 -t  -s


Synopsis
    vc ve inst set cmd -f=<preOrPost> -t=<type> -s=<cmdString> [-s=<cmdString>]…​
                   (-g=<guid> | -n=<name>)


Description
    Set pre/post-snapshot CMD as semi-colon-separated string (-g <GUID> | -n <NAME>) -f <PRE | POST> -t <CMD_TYPE> -s <CMD_STRING>


Options

-g,vm-guid=<guid>

VM guid

-n,vm-name=<name>

VM name

-f,for=<preOrPost>
-t,type=<type>
-s,string=<cmdString>
# vc-ve-inst-set-credentials

Name

vc-ve-inst-set-credentials - Set SSH access credentials (-g | -n )-n -u -p

Synopsis

vc ve inst set credentials -n=<name> -p=<password> -u=<user> (-v=<guid> | -vn=<name>)

Description

Set SSH access credentials (-g <GUID> | -n <NAME>)-n <NAME> -u <SSH_USER> -p <SSH_PASSWORD>

Options

-v, vm-guid**=<guid>*

VM guid

-vn,vm-name=<name>

VM name

-n, name=<name>

-u, user=<user>

-p, password=<password>

vc-ve-inst-set-handling

Name

vc-ve-inst-set-handling - Set handling for pre/post-snap standard error (-g | -n )-f

 -h


Synopsis
    vc ve inst set handling -f=<preOrPost> -h=<handling> (-g=<guid> | -n=<name>)


Description
    Set handling for pre/post-snap standard error (-g <GUID> | -n <NAME>)-f <PRE | POST> -h <HANDLING>


Options

-g,vm-guid=<guid>

VM guid

-n,vm-name=<name>

VM name

-f,for=<preOrPost>
-h,handling=<handling>
# vc-ve-inst-set-host

Name

vc-ve-inst-set-host - Set SSH access host/port (-g | -n )-n -h -p

Synopsis

vc ve inst set host -h=<host> -p=<port> (-g=<guid> | -n=<name>)

Description

Set SSH access host/port (-g <GUID> | -n <NAME>)-n <NAME> -h <SSH_HOST> -p <SSH_PORT>

Options

-g, vm-guid**=<guid>*

VM guid

-n, vm-name**=<name>*

VM name

-h, host**=<host>*

-p, port**=<port>*

vc-ve-inst-set-ignored

Name

vc-ve-inst-set-ignored - Set pre-snap/post-snap ignored command exit codes e.g. '15 101-150' or '' (-g | -n -f

 -c


Synopsis
    vc ve inst set ignored -f=<preOrPost> -c=<codes> [-c=<codes>]…​ (-g=<guid> |
                       -n=<name>)


Description
    Set pre-snap/post-snap ignored command exit codes e.g. '15 101-150' or '*' (-g <GUID> | -n <NAME>-f <PRE | POST> -c <IGNORED_CODES>


Options

-g,vm-guid=<guid>

VM guid

-n,vm-name=<name>

VM name

-f,for=<preOrPost>
-c,codes=<codes>
# vc-ve-inst-set-key

Name

vc-ve-inst-set-key - Set SSH access host/port (-g | -n ) -p

Synopsis

vc ve inst set key -p=<path> (-g=<guid> | -n=<name>)

Description

Set SSH access host/port (-g <GUID> | -n <NAME>) -p <SSH_KEYPATH>

Options

-g, vm-guid**=<guid>*

VM guid

-n, vm-name**=<name>*

VM name

-p, path=<path>

vc-ve-inst-set

Name

vc-ve-inst-set - set commands

Synopsis

vc ve inst set [COMMAND]

Description

set commands

Commands

credentials

Set SSH access credentials (-g <GUID> | -n <NAME>)-n <NAME> -u <SSH_USER> -p <SSH_PASSWORD>

host

Set SSH access host/port (-g <GUID> | -n <NAME>)-n <NAME> -h <SSH_HOST> -p <SSH_PORT>

key

Set SSH access host/port (-g <GUID> | -n <NAME>) -p <SSH_KEYPATH>

handling

Set handling for pre/post-snap standard error (-g <GUID> | -n <NAME>)-f <PRE | POST> -h <HANDLING>

ignored

Set pre-snap/post-snap ignored command exit codes e.g. '15 101-150' or '' (-g <GUID> | -n <NAME>-f <PRE | POST> -c <IGNORED_CODES>

cmdexec

Set pre/post-snapshot CMD exec enabled (1) / disabled (0) -g <GUID> -a <0|1> -f <PRE | POST>

cmd

Set pre/post-snapshot CMD as semi-colon-separated string (-g <GUID> | -n <NAME>) -f <PRE | POST> -t <CMD_TYPE> -s <CMD_STRING>

vc-ve-inst-snapshot-create

Name

vc-ve-inst-snapshot-create - Create VM snapshot (-g | -n )-r -p

Synopsis

vc ve inst snapshot create -p=<priority> -r=<rule> (-g=<guid> | -n=<name>)

Description

Create VM snapshot (-g <GUID> | -n <NAME>)-r <RULE_GUID> -p <PRIORITY>

Options

-g, vm-guid**=<guid>*

VM guid

-n, vm-name**=<name>*

VM name

-r, rule**=<rule>*

-p, priority**=<priority>*

vc-ve-inst-snapshot

Name

vc-ve-inst-snapshot - Snapshot recovery plan policies and rules

Synopsis

vc ve inst snapshot [COMMAND]

Description

Snapshot recovery plan policies and rules

Commands

create

Create VM snapshot (-g <GUID> | -n <NAME>)-r <RULE_GUID> -p <PRIORITY>

remove

Remove old snapshots -g <VM_GUID> | -n <VM_NAME>

revert

Create VM snapshot <SNAPSHOT_GUID>

vc-ve-inst-snapshot-remove

Name

vc-ve-inst-snapshot-remove - Remove old snapshots -g | -n

Synopsis

vc ve inst snapshot remove (-g=<guid> | -n=<name>)

Description

Remove old snapshots -g <VM_GUID> | -n <VM_NAME>

Options

-g, vm-guid**=<guid>* VM guid

-n, vm-name**=<name>* VM name

vc-ve-inst-snapshot-revert

Name

vc-ve-inst-snapshot-revert - Create VM snapshot

Synopsis

vc ve inst snapshot revert -g=<guid>

Description

Create VM snapshot <SNAPSHOT_GUID>

Options

-g, guid=<guid>

vc-ve-mounted-list-backups

Name

vc-ve-mounted-list-backups - List mounted backups

Synopsis

vc ve mounted list backups [-h=<noHeaders>]

Description

List mounted backups

Options

-h, no-headers=<noHeaders>

vc-ve-mounted-list-files

Name

vc-ve-mounted-list-files - List file systems -mg

Synopsis

vc ve mounted list files [-h=<noHeaders>] (-mg=<guid>)

Description

List file systems -mg <GUID>

Options

-mg,mounted-backup-guid=<guid>

Mounted backup guid

-h, no-headers=<noHeaders>

vc-ve-mounted-list-iscsi

Name

vc-ve-mounted-list-iscsi - List files for selected backup, that can be mounted using iSCSI mode. -mg

Synopsis

vc ve mounted list iscsi [-h=<noHeaders>] (-mg=<guid>)

Description

List files for selected backup, that can be mounted using iSCSI mode. -mg <GUID>

Options

-mg,mounted-backup-guid=<guid>

Mounted backup guid

-h, no-headers=<noHeaders>

vc-ve-mounted-list

Name

vc-ve-mounted-list - List commnads

Synopsis

vc ve mounted list [COMMAND]

Description

List commnads

Commands

files

List file systems -mg <GUID>

iscsi

List files for selected backup, that can be mounted using iSCSI mode. -mg <GUID>

backups

List mounted backups

mountedfiles

List mounted files -mg <GUID>

tasks

List tasks related to the mounted backup -mg <GUID>

vc-ve-mounted-list-mountedfiles

Name

vc-ve-mounted-list-mountedfiles - List mounted files -mg

Synopsis

vc ve mounted list mountedfiles [-h=<noHeaders>] (-mg=<guid>)

Description

List mounted files -mg <GUID>

Options

-mg,mounted-backup-guid=<guid>

Mounted backup guid

-h, no-headers=<noHeaders>

vc-ve-mounted-list-tasks

Name

vc-ve-mounted-list-tasks - List tasks related to the mounted backup -mg

Synopsis

vc ve mounted list tasks [-h=<noHeaders>] (-mg=<guid>)

Description

List tasks related to the mounted backup -mg <GUID>

Options

-mg,mounted-backup-guid=<guid>

Mounted backup guid

-h, no-headers=<noHeaders>

vc-ve-mounted

Name

vc-ve-mounted - Mounted backups

Synopsis

vc ve mounted [COMMAND]

Description

Mounted backups

Commands

list

List commnads

mount

Mount backup according to the MOUNT_SPECIFICATION

-b <BACKUP_LOCATION_GUID>

-n <NODE_GUID | NODE_NAME>

-a <AUTO> -h <HOURS> -m <MOUNT_SPECIFICATION>

ms

Mount iSCSI. -b <BACKUP_LOCATION_GUID>

-n <NODE_CONFIG_GUID | NODE_CONFIG_NAME>

-a <ALLOWED_CLIENT>,…​,<ALLOWED_CLIENT>

-d <DISK_GUID>,…​,<DISK_GUID>

um

Unmount previously mounted backup -mg <GUID>

vc-ve-mounted-mount

Name

vc-ve-mounted-mount - Mount backup according to the MOUNT_SPECIFICATION -b -n -a -h -m

Synopsis

vc ve mounted mount -a=<auto> -b=<backupLocation> -h=<hours> -m=<mount> -n=<node>

Description

Mount backup according to the MOUNT_SPECIFICATION -b <BACKUP_LOCATION_GUID> -n <NODE_GUID | NODE_NAME> -a <AUTO> -h <HOURS> -m <MOUNT_SPECIFICATION>

Options

-b, backup**=<backupLocation>* Backup location GUID

-n, node**=<node>* Node GUID or NAME

-a, auto**=<auto>* If auto - YES, manual - NO

-h, hours**=<hours>* Hours to auto unmount

-m, mount**=<mount>* Mount specification

vc-ve-mounted-ms

Name

vc-ve-mounted-ms - Mount iSCSI. -b -n -a ,..., -d ,...,

Synopsis

vc ve mounted ms -b=<backupLocation> -n=<nodeConfig> -a=<allowedClients>[, <allowedClients>…​] [-a=<allowedClients>[, <allowedClients>…​]]…​ -d=<disks>[,<disks>…​] [-d=<disks>[, <disks>…​]]…​

Description

Mount iSCSI. -b <BACKUP_LOCATION_GUID> -n <NODE_CONFIG_GUID | NODE_CONFIG_NAME> -a <ALLOWED_CLIENT>,…​,<ALLOWED_CLIENT> -d <DISK_GUID>,…​,<DISK_GUID>

Options

-b, backup**=<backupLocation>* Backup location GUID

-n, node-config**=<nodeConfig>* Node Config GUID or NAME

-a, allowed-client**=<allowedClients>[,<allowedClients>*…​] GUID,…​,GUID (No spaces)

-d, disk**=<disks>[,<disks>*…​] GUID,…​,GUID (No spaces)

vc-ve-mounted-um

Name

vc-ve-mounted-um - Unmount previously mounted backup -mg

Synopsis

vc ve mounted um (-mg=<guid>)

Description

Unmount previously mounted backup -mg <GUID>

Options

-mg,mounted-backup-guid=<guid> Mounted backup guid

vc-ve-recovery

Name

vc-ve-recovery - Recovery plans

Synopsis

vc ve recovery [COMMAND]

Description

Recovery plans

Commands

recovery

Recovery plans

schedule

Policy schedules

vc-ve-recovery-recovery-create

Name

vc-ve-recovery-recovery-create - Create a new policy

Synopsis

vc ve recovery recovery create <name>

Description

Create a new policy <NAME>

Arguments

<name>

vc-ve-recovery-recovery-delete

Name

vc-ve-recovery-recovery-delete - Delete a policy (-rg | -rn )

Synopsis

vc ve recovery recovery delete (-rg=<guid> | -rn=<name>)

Description

Delete a policy (-rg <POLICY_GUID> | -rn <POLICY_NAME>)

Options

-rg,recovery-guid=<guid> Recovery plan guid

-rn,recovery-name=<name> Recovery plan name

vc-ve-recovery-recovery-details

Name

vc-ve-recovery-recovery-details - Show policy details (-rg | -rn )

Synopsis

vc ve recovery recovery details (-rg=<guid> | -rn=<name>)

Description

Show policy details (-rg <POLICY_GUID> | -rn <POLICY_NAME>)

Options

-rg,recovery-guid=<guid> Recovery plan guid

-rn,recovery-name=<name> Recovery plan name

vc-ve-recovery-recovery-list

Name

vc-ve-recovery-recovery-list - List recovery plan policies

Synopsis

vc ve recovery recovery list [-h=<noHeaders>]

Description

List recovery plan policies

Options

-h, no-headers=<noHeaders>

vc-ve-recovery-recovery

Name

vc-ve-recovery-recovery - Recovery plans

Synopsis

vc ve recovery recovery [COMMAND]

Description

Recovery plans

Commands

create

Create a new policy <NAME>

delete

Delete a policy (-rg <POLICY_GUID> | -rn <POLICY_NAME>)

details

Show policy details (-rg <POLICY_GUID> | -rn <POLICY_NAME>)

list

List recovery plan policies

update

Update a policy (-rg <POLICY_GUID> | -rn <POLICY_NAME>) -n- <NAME>

set

Set recovery plan policies and rules

rule

Rule recovery plan policies and rules

vc-ve-recovery-recovery-rule-active

Name

vc-ve-recovery-recovery-rule-active - Set rule activation state (YES|NO) (-rg | -rn ) -a

Synopsis

vc ve recovery recovery rule active -a=<active> (-rg=<guid> | -rn=<name>)

Description

Set rule activation state (YES|NO) (-rg <RULE_GUID> | -rn <RULE_NAME>) -a <ACTIVE>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-a, active=<active> YES or NO

vc-ve-recovery-recovery-rule-add

Name

vc-ve-recovery-recovery-rule-add - Add new rule to selected policy -n (-rg | -rn )

Synopsis

vc ve recovery recovery rule add -n=<name> (-rg=<guid> | -rn=<name>)

Description

Add new rule to selected policy -n <NAME> (-rg <POLICY_GUID> | -rn <POLICY_NAME>)

Options

-rg,recovery-guid=<guid>

Recovery plan guid

-rn,recovery-name=<name>

Recovery plan name

-n, name=<name>

vc-ve-recovery-recovery-rule-auto

Name

vc-ve-recovery-recovery-rule-auto - Set rule use auto generated name (-rg | -rn ) -a

Synopsis

vc ve recovery recovery rule auto -a=<auto> (-rg=<guid> | -rn=<name>)

Description

Set rule use auto generated name (-rg <RULE_GUID> | -rn <RULE_NAME>) -a <AUTO>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-a, auto**=<auto>* YES or NO

vc-ve-recovery-recovery-rule-cluster

Name

vc-ve-recovery-recovery-rule-cluster - Set restore cluster id in rule (-rg | -rn ) -c

Synopsis

vc ve recovery recovery rule cluster -c=<cluster> (-rg=<guid> | -rn=<name>)

Description

Set restore cluster id in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -c <RESTORE_CLUSTER_ID>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-c, cluster**=<cluster>* Restore cluster ID

vc-ve-recovery-recovery-rule-dc

Name

vc-ve-recovery-recovery-rule-dc - Set data center in rule (-rg | -rn ) -d

Synopsis

vc ve recovery recovery rule dc -d=<dataCenterGuid> (-rg=<guid> | -rn=<name>)

Description

Set data center in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -d <DATA_CENTER>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-d, data-center**=<dataCenterGuid>* Data Center GUID

vc-ve-recovery-recovery-rule-format

Name

vc-ve-recovery-recovery-rule-format - Set disk allocation format in rule (-rg | -rn ) -f

Synopsis

vc ve recovery recovery rule format -f=<format> (-rg=<guid> | -rn=<name>)

Description

Set disk allocation format in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -f <ALLOCATION_FORMAT>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-f, format**=<format>* PREALLOCATED, SPARSE, THIN, THICK, EAGERZEROED, FIXED_SIZE, DYNAMICALLY_EXPANDING

vc-ve-recovery-recovery-rule-hv

Name

vc-ve-recovery-recovery-rule-hv - Set hypervisor in rule (-rg | -rn ) (-hg | -hn

Synopsis

vc ve recovery recovery rule hv (-rg=<guid> | -rn=<name>) (-hg=<guid> | -hn=<name>)

Description

Set hypervisor in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) (-hg <HYPERVISOR_GUID> | -hn <HYPERVISOR_NAME>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-hg,hypervisor-guid=<guid> Hypervisor guid

-hn,hypervisor-name=<name> Hypervisor name

vc-ve-recovery-recovery-rule-hvmtype

Name

vc-ve-recovery-recovery-rule-hvmtype - Set hypervisor manager type in rule (-rg | -rn ) -h

Synopsis

vc ve recovery recovery rule hvmtype -h=<hvmType> (-rg=<guid> | -rn=<name>)

Description

Set hypervisor manager type in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -h <HVM_TYPE>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-h, hypervisor-type**=<hvmType>* RHEV, RHV, ORACLE, NUTANIX, KUBERNETES, AWS, OPENSTACK, OPENSHIFT, VCENTER, FUSIONCOMPUTE, HC3, HYPERV

vc-ve-recovery-recovery-rule-hvtype

Name

vc-ve-recovery-recovery-rule-hvtype - Set hypervisor type in rule (-rg | -rn ) -h

Synopsis

vc ve recovery recovery rule hvtype -h=<hvType> (-rg=<guid> | -rn=<name>)

Description

Set hypervisor type in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -h <HVM>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-h, hypervisor**=<hvType>* CITRIX, XEN, KVM, OVM, PROXMOX, NUTANIX, KUBERNETES, OPENSHIFT, ESXI, HYPERV

vc-ve-recovery-recovery-rule-image

Name

vc-ve-recovery-recovery-rule-image - Set base image to rule (-rg | -rn ) -b

Synopsis

vc ve recovery recovery rule image -b=<baseImage> (-rg=<guid> | -rn=<name>)

Description

Set base image to rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -b <BASE_IMAGE>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-b, base**=<baseImage>* Base image UUID

vc-ve-recovery-recovery-rule-list

Name

vc-ve-recovery-recovery-rule-list - List rules for policy (-rg | -rn )

Synopsis

vc ve recovery recovery rule list (-rg=<guid> | -rn=<name>)

Description

List rules for policy (-rg <GUID> | -rn <NAME>)

Options

-rg,recovery-guid=<guid> Recovery plan guid

-rn,recovery-name=<name> Recovery plan name

vc-ve-recovery-recovery-rule

Name

vc-ve-recovery-recovery-rule - Rule recovery plan policies and rules

Synopsis

vc ve recovery recovery rule [COMMAND]

Description

Rule recovery plan policies and rules

Commands

add

Add new rule to selected policy -n <NAME> (-rg <POLICY_GUID> | -rn <POLICY_NAME>)

list

List rules for policy (-rg <GUID> | -rn <NAME>)

remove

Remove rules from policy -g <GUID> -r <RULE_GUID>,…​,<RULE_GUID>

image

Set base image to rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -b <BASE_IMAGE>

hv

Set hypervisor in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) (-hg <HYPERVISOR_GUID> | -hn <HYPERVISOR_NAME>

hvmtype

Set hypervisor manager type in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -h <HVM_TYPE>

hvtype

Set hypervisor type in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -h <HVM>

active

Set rule activation state (YES|NO) (-rg <RULE_GUID> | -rn <RULE_NAME>) -a <ACTIVE>

selection

Set backup selection in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -s <SELECTION>

dc

Set data center in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -d <DATA_CENTER>

format

Set disk allocation format in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -f <ALLOCATION_FORMAT>

ow

Set overwrite status in rule (YES|NO) (-rg <RULE_GUID> | -rn <RULE_NAME>) -a <OVERWRITE>

cluster

Set restore cluster id in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -c <RESTORE_CLUSTER_ID>

vmname

Set target VM name in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -n <NAME>

path

Set restore path in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -p <PATH>

project

Set target project in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -p <PROJECT>

storage

Set restore storage id in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -s <STORAGE_ID>

auto

Set rule use auto generated name (-rg <RULE_GUID> | -rn <RULE_NAME>) -a <AUTO>

vm

Add virtual machines to rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -v <VM>,…​<VM>

vc-ve-recovery-recovery-rule-ow

Name

vc-ve-recovery-recovery-rule-ow - Set overwrite status in rule (YES|NO) (-rg | -rn ) -a

Synopsis

vc ve recovery recovery rule ow -o=<overwrite> (-rg=<guid> | -rn=<name>)

Description

Set overwrite status in rule (YES|NO) (-rg <RULE_GUID> | -rn <RULE_NAME>) -a <OVERWRITE>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-o, overwrite**=<overwrite>* YES or NO

vc-ve-recovery-recovery-rule-path

Name

vc-ve-recovery-recovery-rule-path - Set restore path in rule (-rg | -rn ) -p

Synopsis

vc ve recovery recovery rule path -p=<path> (-rg=<guid> | -rn=<name>)

Description

Set restore path in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -p <PATH>

Options

-rg,recovery-rule-guid=<guid>

Recovery plan rule guid

-rn,recovery-rule-name=<name>

Recovery plan rule name

-p, path=<path>

vc-ve-recovery-recovery-rule-project

Name

vc-ve-recovery-recovery-rule-project - Set target project in rule (-rg | -rn ) -p

Synopsis

vc ve recovery recovery rule project -p=<project> (-rg=<guid> | -rn=<name>)

Description

Set target project in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -p <PROJECT>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-p, project**=<project>* Project GUID

vc-ve-recovery-recovery-rule-remove

Name

vc-ve-recovery-recovery-rule-remove - Remove rules from policy -g -r ,...,

Synopsis

vc ve recovery recovery rule remove -r=<rules>[,<rules>…​] [-r=<rules>[, <rules>…​]]…​ (-rg=<guid> | -rn=<name>)

Description

Remove rules from policy -g <GUID> -r <RULE_GUID>,…​,<RULE_GUID>

Options

-rg,recovery-guid=<guid> Recovery plan guid

-rn,recovery-name=<name> Recovery plan name

-r, rule**=<rules>[,<rules>*…​] Rule GUIDs (no spaces)

vc-ve-recovery-recovery-rule-selection

Name

vc-ve-recovery-recovery-rule-selection - Set backup selection in rule (-rg | -rn ) -s

Synopsis

vc ve recovery recovery rule selection -s=<selection> (-rg=<guid> | -rn=<name>)

Description

Set backup selection in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -s <SELECTION>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-s, selection**=<selection>* LAST_SUCCESSFUL, ANY

vc-ve-recovery-recovery-rule-storage

Name

vc-ve-recovery-recovery-rule-storage - Set restore storage id in rule (-rg | -rn ) -s

Synopsis

vc ve recovery recovery rule storage -s=<storage> (-rg=<guid> | -rn=<name>)

Description

Set restore storage id in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -s <STORAGE_ID>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-s, storage**=<storage>* Storage ID

vc-ve-recovery-recovery-rule-vm

Name

vc-ve-recovery-recovery-rule-vm - Add virtual machines to rule (-rg | -rn ) -v ,...

Synopsis

vc ve recovery recovery rule vm -v=<vms> [-v=<vms>]…​ (-rg=<guid> | -rn=<name>)

Description

Add virtual machines to rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -v <VM>,…​<VM>

Options

-rg,recovery-rule-guid=<guid> Recovery plan rule guid

-rn,recovery-rule-name=<name> Recovery plan rule name

-v, virtual-machine**=<vms>* Virtual machine GUIDs

vc-ve-recovery-recovery-rule-vmname

Name

vc-ve-recovery-recovery-rule-vmname - Set target VM name in rule (-rg | -rn ) -n

Synopsis

vc ve recovery recovery rule vmname -n=<name> (-rg=<guid> | -rn=<name>)

Description

Set target VM name in rule (-rg <RULE_GUID> | -rn <RULE_NAME>) -n <NAME>

Options

-rg,recovery-rule-guid=<guid>

Recovery plan rule guid

-rn,recovery-rule-name=<name>

Recovery plan rule name

-n, name=<name>

vc-ve-recovery-recovery-set-active

Name

vc-ve-recovery-recovery-set-active - Set policy's activation state (YES|NO) (-rg | -rn ) -a

Synopsis

vc ve recovery recovery set active -a=<active> (-rg=<guid> | -rn=<name>)

Description

Set policy’s activation state (YES|NO) (-rg <POLICY_GUID> | -rn <POLICY_NAME>) -a <ACTIVE>

Options

-rg,recovery-guid=<guid> Recovery plan guid

-rn,recovery-name=<name> Recovery plan name

-a, active=<active> YES or NO

vc-ve-recovery-recovery-set

Name

vc-ve-recovery-recovery-set - Set recovery plan policies and rules

Synopsis

vc ve recovery recovery set [COMMAND]

Description

Set recovery plan policies and rules

Commands

active

Set policy’s activation state (YES|NO) (-rg <POLICY_GUID> | -rn <POLICY_NAME>) -a <ACTIVE>

priority

Set policy’s backup task priority (-rg <POLICY_GUID> | -rn <POLICY_NAME>) -p <PRIORITY>

vc-ve-recovery-recovery-set-priority

Name

vc-ve-recovery-recovery-set-priority - Set policy's backup task priority (-rg | -rn ) -p

Synopsis

vc ve recovery recovery set priority -p=<priority> (-rg=<guid> | -rn=<name>)

Description

Set policy’s backup task priority (-rg <POLICY_GUID> | -rn <POLICY_NAME>) -p <PRIORITY>

Options

-rg,recovery-guid=<guid> Recovery plan guid

-rn,recovery-name=<name> Recovery plan name

-p, priority**=<priority>* Range 0-100

vc-ve-recovery-recovery-update

Name

vc-ve-recovery-recovery-update - Update a policy (-rg | -rn ) -n-

Synopsis

vc ve recovery recovery update -n=<name> (-rg=<guid> | -rn=<name>)

Description

Update a policy (-rg <POLICY_GUID> | -rn <POLICY_NAME>) -n- <NAME>

Options

-rg,recovery-guid=<guid> Recovery plan guid

-rn,recovery-name=<name> Recovery plan name

-n, name=<name> Policy new name

vc-ve-recovery-schedule-active

Name

vc-ve-recovery-schedule-active - Set schedule to be active (YES or NO) -g -a

Synopsis

vc ve recovery 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

vc-ve-recovery-schedule-add

Name

vc-ve-recovery-schedule-add - Add policy to schedule

Synopsis

vc ve recovery schedule add (-s=<guid> | -sn=<name>) (-p=<guid> | -pn=<name>)

Description

Add policy to schedule

Options

-s, sched-guid=<guid> Schedule guid

-sn,sched-name=<name> Schedule name

-p, policy-guid=<guid> Policy guid

-pn,policy-name=<name> Policy name

vc-ve-recovery-schedule-create

Name

vc-ve-recovery-schedule-create - Create new schedule

Synopsis

vc ve recovery 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

vc-ve-recovery-schedule-delete

Name

vc-ve-recovery-schedule-delete - Delete schedule

Synopsis

vc ve recovery schedule delete (-sg=<policyGuid> | -sn=<policyName>)

Description

Delete schedule <GUID>

Options

-sg,schedule-guid=<policyGuid> Recovery plan schedule guid

-sn,schedule-name=<policyName> Recovery plan schedule name

vc-ve-recovery-schedule-details

Name

vc-ve-recovery-schedule-details - Show schedule details

Synopsis

vc ve recovery schedule details <guid>

Description

Show schedule details <GUID>

Arguments

<guid>

vc-ve-recovery-schedule-list

Name

vc-ve-recovery-schedule-list - List recovery plan schedules

Synopsis

vc ve recovery schedule list [-h=<noHeaders>]

Description

List recovery plan schedules

Options

-h, no-headers=<noHeaders>

vc-ve-recovery-schedule

Name

vc-ve-recovery-schedule - Policy schedules

Synopsis

vc ve recovery schedule [COMMAND]

Description

Policy schedules

Commands

list

List recovery plan schedules

create

Create new schedule

update

Update schedule

delete

Delete schedule <GUID>

details

Show schedule details <GUID>

active

Set schedule to be active (YES or NO) -g <GUID> -a <ACTIVE>

add

Add policy to schedule

vc-ve-recovery-schedule-update

Name

vc-ve-recovery-schedule-update - Update schedule

Synopsis

vc ve recovery schedule update -b=<backupType> -d=<duration> -g=<guid> -n=<name> -se=<scheduleExecutionType> -t=<time> -dw=<daysOfWeek> [-dw=<daysOfWeek>]…​ -m=<months> [-m=<months>]…​ -o=<occurrence> [-o=<occurrence>]…​

Description

Update schedule

Options

-g, guid=<guid> -n, name=<name> -b, backup-type=<backupType> Types: FULL, INCREMENTAL, SYNTHETIC, SYNCHRONIZATION

-se,exec-type=<scheduleExecutionType> Schedule exec type. Types: TIME, INTERVAL

-t, time=<time> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR>

-d, duration=<duration> <DURATION | INTERVAL_FREQUENCY>

-dw,days-of-week=<daysOfWeek> <EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY>

-o, occurrence=<occurrence> <ANY, FIRST_IN_MONTH, SECOND_IN_MONTH, THIRD_IN_MONTH, FOURTH_IN_MONTH, LAST_IN_MONTH>

-m, months=<months> <ANY, JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER>

vc-ve-snapshot

Name

vc-ve-snapshot - Snapshot SLA

Synopsis

vc ve snapshot [COMMAND]

Description

Snapshot SLA

Commands

policy

Snapshot SLA

schedule

Schedule instances

vc-ve-snapshot-policy-addrule

Name

vc-ve-snapshot-policy-addrule - Add new rule to selected policy -n (-pg | -pn ) -r -v

Synopsis

vc ve snapshot policy addrule -n=<name> -r=<days> -v=<version> (-pg=<guid> | -pn=<name>)

Description

Add new rule to selected policy -n <NAME> (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -r <RETENTION_DAYS> -v <RETENTION_VERSIONS>

Options

-n, name=<name>

-pg,policy-guid=<guid>

Snapshot policy guid

-pn,policy-name=<name>

Snapshot policy name

-r, retention-days**=<days>*

-v, retention-version**=<version>*

vc-ve-snapshot-policy-addtag

Name

vc-ve-snapshot-policy-addtag - Add auto-assignment tag (-pg | -pn ) -t -a

Synopsis

vc ve snapshot policy addtag -a=<tag> -t=<type> (-pg=<guid> | -pn=<name>)

Description

Add auto-assignment tag (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -t <TYPE> -a <TAG>

Options

-pg,policy-guid=<guid>

Snapshot policy guid

-pn,policy-name=<name>

Snapshot policy name

-t, type**=<type>*

Types: INCLUDE, EXCLUDE

-a, tag**=<tag>*

vc-ve-snapshot-policy-assign

Name

vc-ve-snapshot-policy-assign - Assign VMs to the policy (-pg | -pn ) -v ,...,

Synopsis

vc ve snapshot policy assign -v=<vmGuid>[,<vmGuid>…​] [-v=<vmGuid>[, <vmGuid>…​]]…​ (-pg=<guid> | -pn=<name>)

Description

Assign VMs to the policy (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -v <VM_GUID>,…​,<VM_GUID>

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

-v, vm-guid**=<vmGuid>[,<vmGuid>*…​] GUID,…​,GUID (No spaces)

vc-ve-snapshot-policy-create

Name

vc-ve-snapshot-policy-create - Create a new policy

Synopsis

vc ve snapshot policy create <name>

Description

Create a new policy <NAME>

Arguments

<name>

vc-ve-snapshot-policy-delete

Name

vc-ve-snapshot-policy-delete - Delete policy (-pg | -pn )

Synopsis

vc ve snapshot policy delete (-pg=<guid> | -pn=<name>)

Description

Delete policy (-pg <POLICY_GUID> | -pn <POLICY_NAME>)

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

vc-ve-snapshot-policy-details

Name

vc-ve-snapshot-policy-details - Show details (-pg | -pn )

Synopsis

vc ve snapshot policy details (-pg=<guid> | -pn=<name>)

Description

Show details (-pg <POLICY_GUID> | -pn <POLICY_NAME>)

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

vc-ve-snapshot-policy-list

Name

vc-ve-snapshot-policy-list - Lists commands

Synopsis

vc ve snapshot policy list [COMMAND]

Description

Lists commands

Commands

policy

List snapshot policies

vms

List VMs in the policy (-pg <POLICY_GUID> | -pn <POLICY_NAME>)

rule

List rules in the policy (-pg <POLICY_GUID> | -pn <POLICY_NAME>)

vc-ve-snapshot-policy-list-policy

Name

vc-ve-snapshot-policy-list-policy - List snapshot policies

Synopsis

vc ve snapshot policy list policy [-h=<noHeaders>]

Description

List snapshot policies

Options

-h, no-headers=<noHeaders>

vc-ve-snapshot-policy-list-rule

Name

vc-ve-snapshot-policy-list-rule - List rules in the policy (-pg | -pn )

Synopsis

vc ve snapshot policy list rule [-h=<noHeaders>] (-pg=<guid> | -pn=<name>)

Description

List rules in the policy (-pg <POLICY_GUID> | -pn <POLICY_NAME>)

Options

-h, no-headers=<noHeaders> -pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

vc-ve-snapshot-policy-list-vms

Name

vc-ve-snapshot-policy-list-vms - List VMs in the policy (-pg | -pn )

Synopsis

vc ve snapshot policy list vms [-h=<noHeaders>] (-pg=<guid> | -pn=<name>)

Description

List VMs in the policy (-pg <POLICY_GUID> | -pn <POLICY_NAME>)

Options

-h, no-headers=<noHeaders> -pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

vc-ve-snapshot-policy

Name

vc-ve-snapshot-policy - Snapshot SLA

Synopsis

vc ve snapshot policy [COMMAND]

Description

Snapshot SLA

Commands

list

Lists commands

set

Set recovery plan policies and rules

details

Show details (-pg <POLICY_GUID> | -pn <POLICY_NAME>)

create

Create a new policy <NAME>

delete

Delete policy (-pg <POLICY_GUID> | -pn <POLICY_NAME>)

addrule

Add new rule to selected policy -n <NAME> (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -r <RETENTION_DAYS> -v <RETENTION_VERSIONS>

addtag

Add auto-assignment tag (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -t <TYPE> -a <TAG>

update

Modify policy name (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -n <NAME>

removerule

Remove rules from policy -(-pg <POLICY_GUID> | -pn <POLICY_NAME>) -r <RULE_GUID>,…​,<RULE_GUID>

removetag

Remove auto-assignment tag (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -t <RETENTION_DAYS> -a <TAG>

unassign

Unassign VMs from the policy <VM_GUID>,…​,<VM_GUID>

assign

Assign VMs to the policy (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -v <VM_GUID>,…​,<VM_GUID>

vc-ve-snapshot-policy-removerule

Name

vc-ve-snapshot-policy-removerule - Remove rules from policy -(-pg | -pn ) -r ,...,

Synopsis

vc ve snapshot policy removerule -r=<rule>[,<rule>…​] [-r=<rule>[, <rule>…​]]…​ (-pg=<guid> | -pn=<name>)

Description

Remove rules from policy -(-pg <POLICY_GUID> | -pn <POLICY_NAME>) -r <RULE_GUID>,…​,<RULE_GUID>

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

-r, rule**=<rule>[,<rule>*…​] GUID,…​,GUID (No spaces)

vc-ve-snapshot-policy-removetag

Name

vc-ve-snapshot-policy-removetag - Remove auto-assignment tag (-pg | -pn ) -t -a

Synopsis

vc ve snapshot policy removetag -a=<tag> -t=<type> (-pg=<guid> | -pn=<name>)

Description

Remove auto-assignment tag (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -t <RETENTION_DAYS> -a <TAG>

Options

-pg,policy-guid=<guid>

Snapshot policy guid

-pn,policy-name=<name>

Snapshot policy name

-t, type**=<type>*

Types: INCLUDE, EXCLUDE

-a, tag**=<tag>*

vc-ve-snapshot-policy-set-activation

Name

vc-ve-snapshot-policy-set-activation - Set policy activation state (-pg | -pn ) -a

Synopsis

vc ve snapshot policy set activation -a=<active> (-pg=<guid> | -pn=<name>)

Description

Set policy activation state (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -a <YES | NO>

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

-a, active=<active> YES or NO

vc-ve-snapshot-policy-set-auto

Name

vc-ve-snapshot-policy-set-auto - Set auto-assignment HV clusters (-pg | -pn ) (-cg | -cn )

Synopsis

vc ve snapshot policy set auto (-pg=<guid> | -pn=<name>) (-cg=<guid> | -cn=<name>)

Description

Set auto-assignment HV clusters (-pg <POLICY_GUID> | -pn <POLICY_NAME>) (-cg <CLUSTER_GUID> | -cn <CLUSTER_NAME>)

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

-cg,hypervisor-cluster-guid=<guid> Hypervisor cluster guid

-cn,hypervisor-cluster-name=<name> Hypervisor cluster name

vc-ve-snapshot-policy-set

Name

vc-ve-snapshot-policy-set - Set recovery plan policies and rules

Synopsis

vc ve snapshot policy set [COMMAND]

Description

Set recovery plan policies and rules

Commands

auto

Set auto-assignment HV clusters (-pg <POLICY_GUID> | -pn <POLICY_NAME>) (-cg <CLUSTER_GUID> | -cn <CLUSTER_NAME>)

activation

Set policy activation state (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -a <YES | NO>

removal

Set auto-removal of non-present VMs flag (-pg <POLICY_GUID> | -pn <POLICY_NAME>)-a <YES | NO>

mode

Set auto-assignment mode (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -m <MODE>

priority

Set policy’s backup task priority (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -p <PRIORITY>

retry

Set snapshot policy retry count (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -r <RETRY_COUNT>

vc-ve-snapshot-policy-set-mode

Name

vc-ve-snapshot-policy-set-mode - Set auto-assignment mode (-pg | -pn ) -m

Synopsis

vc ve snapshot policy set mode -m=<mode> (-pg=<guid> | -pn=<name>)

Description

Set auto-assignment mode (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -m <MODE>

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

-m, mode**=<mode>* Modes: DISABLED, ASSIGN_ONLY, ASSIGN_AND_REMOVE

vc-ve-snapshot-policy-set-priority

Name

vc-ve-snapshot-policy-set-priority - Set policy's backup task priority (-pg | -pn ) -p

Synopsis

vc ve snapshot policy set priority -p=<priority> (-pg=<guid> | -pn=<name>)

Description

Set policy’s backup task priority (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -p <PRIORITY>

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

-p, priority**=<priority>* Range: 0-100 (50 default)

vc-ve-snapshot-policy-set-removal

Name

vc-ve-snapshot-policy-set-removal - Set auto-removal of non-present VMs flag (-pg | -pn )-a

Synopsis

vc ve snapshot policy set removal -a=<auto> (-pg=<guid> | -pn=<name>)

Description

Set auto-removal of non-present VMs flag (-pg <POLICY_GUID> | -pn <POLICY_NAME>)-a <YES | NO>

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

-a, auto**=<auto>* YES or NO

vc-ve-snapshot-policy-set-retry

Name

vc-ve-snapshot-policy-set-retry - Set snapshot policy retry count (-pg | -pn ) -r

Synopsis

vc ve snapshot policy set retry -r=<retryCount> (-pg=<guid> | -pn=<name>)

Description

Set snapshot policy retry count (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -r <RETRY_COUNT>

Options

-pg,policy-guid=<guid> Snapshot policy guid

-pn,policy-name=<name> Snapshot policy name

-r, retry-count**=<retryCount>* Snapshot retry count

vc-ve-snapshot-policy-unassign

Name

vc-ve-snapshot-policy-unassign - Unassign VMs from the policy ,...,

Synopsis

vc ve snapshot policy unassign [<guids>[,<guids>…​]…​]

Description

Unassign VMs from the policy <VM_GUID>,…​,<VM_GUID>

Arguments

[<guids>[,<guids>…​]…​] GUID,…​,GUID (No spaces)

vc-ve-snapshot-policy-update

Name

vc-ve-snapshot-policy-update - Modify policy name (-pg | -pn ) -n

Synopsis

vc ve snapshot policy update -n=<name> (-pg=<guid> | -pn=<name>)

Description

Modify policy name (-pg <POLICY_GUID> | -pn <POLICY_NAME>) -n <NAME>

Options

-pg,policy-guid=<guid>

Snapshot policy guid

-pn,policy-name=<name>

Snapshot policy name

-n, name=<name>

vc-ve-snapshot-schedule-active

Name

vc-ve-snapshot-schedule-active - Set schedule to be active (YES or NO) -g -a

Synopsis

vc ve snapshot 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

vc-ve-snapshot-schedule-add

Name

vc-ve-snapshot-schedule-add - Add policy to schedule

Synopsis

vc ve snapshot schedule add (-s=<guid> | -sn=<name>) (-p=<guid> | -pn=<name>)

Description

Add policy to schedule

Options

-s, sched-guid=<guid> Schedule guid

-sn,sched-name=<name> Schedule name

-p, policy-guid=<guid> Policy guid

-pn,policy-name=<name> Policy name

vc-ve-snapshot-schedule-create

Name

vc-ve-snapshot-schedule-create - Create new schedule

Synopsis

vc ve snapshot schedule create [-a=<active>] -b=<backupType> -d=<duration> -e=<scheduleExecutionType> -n=<name> -s=<scheduleType> -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> -s, sched-type**=<scheduleType>* Types: VM_BACKUP, VM_SNAPSHOT, VM_RESTORE

-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

vc-ve-snapshot-schedule-delete

Name

vc-ve-snapshot-schedule-delete - Delete schedule

Synopsis

vc ve snapshot schedule delete (-sg=<scheduleGuid> | -sn=<scheduleName>)

Description

Delete schedule <GUID>

Options

-sg,schedule-guid=<scheduleGuid> VM backup schedule guid

-sn,schedule-name=<scheduleName> VM backup schedule name

vc-ve-snapshot-schedule-details

Name

vc-ve-snapshot-schedule-details - Show schedule details

Synopsis

vc ve snapshot schedule details <guid>

Description

Show schedule details <GUID>

Arguments

<guid>

vc-ve-snapshot-schedule-list

Name

vc-ve-snapshot-schedule-list - List snapshot schedules

Synopsis

vc ve snapshot schedule list [-h=<noHeaders>]

Description

List snapshot schedules

Options

-h, no-headers=<noHeaders>

vc-ve-snapshot-schedule

Name

vc-ve-snapshot-schedule - Schedule instances

Synopsis

vc ve snapshot schedule [COMMAND]

Description

Schedule instances

Commands

list

List snapshot schedules

create

Create new schedule

update

Update schedule

delete

Delete schedule <GUID>

details

Show schedule details <GUID>

active

Set schedule to be active (YES or NO) -g <GUID> -a <ACTIVE>

add

Add policy to schedule

vc-ve-snapshot-schedule-update

Name

vc-ve-snapshot-schedule-update - Update schedule

Synopsis

vc ve snapshot schedule update -b=<backupType> -d=<duration> -g=<guid> -n=<name> -se=<scheduleExecutionType> -t=<time> -dw=<daysOfWeek> [-dw=<daysOfWeek>]…​ -m=<months> [-m=<months>]…​ -o=<occurrence> [-o=<occurrence>]…​

Description

Update schedule

Options

-g, guid=<guid> -n, name=<name> -b, backup-type=<backupType> Types: FULL, INCREMENTAL, SYNTHETIC, SYNCHRONIZATION

-se,exec-type=<scheduleExecutionType> Schedule exec type. Types: TIME, INTERVAL

-t, time=<time> <START_TIME | INTERVAL_START_HOUR-INTERVAL_END_HOUR>

-d, duration=<duration> <DURATION | INTERVAL_FREQUENCY>

-dw,days-of-week=<daysOfWeek> <EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY>

-o, occurrence=<occurrence> <ANY, FIRST_IN_MONTH, SECOND_IN_MONTH, THIRD_IN_MONTH, FOURTH_IN_MONTH, LAST_IN_MONTH>

-m, months=<months> <ANY, JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER>

Last updated