Cisco.HXPowerCLI.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Cisco.HXPowerCLI</name> </assembly> <members> <member name="M:Cisco.Runbook.HXTimeUtil.ConvertDateTimeToEpochTimestamp(System.DateTime)"> <summary> Convert to unixTimestamp from DateTime format </summary> <param name="dateTime">DateTime</param> <returns></returns> </member> <member name="T:Cisco.Runbook.ProtectVM"> <summary> <para type="synopsis">Protects an independent virtual machine or list of VMs by adding it to the protection group.</para> <para type="description">Protects an independent standalone VM with a schedule or list of VMs by adding it to the protection group.</para> </summary> <example> <code>C:\> Protect-HXVM -ClusterIP 10.198.14.227 -VMName DemoVM2 -Interval '12 hr'</code> <para>Output</para> <para>-----------------------------</para> <para>VM has been protected.</para> <para> </para> </example> <example> <code>C:\> Protect-HXVM -ClusterIP 10.198.14.227 -VMId 421f0f84-0b3f-fe3a-311c-763f409b3665 -Interval '5 min'</code> <para>Output</para> <para>-----------------------------</para> <para>VM has been protected.</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <example> <code>C:\> Protect-HXVM -ClusterIP 10.198.14.227 -VMId 421f0f84-0b3f-fe3a-311c-763f409b3665 -Interval '5 min' -QuiesceUsingTools -StartTime '08/07/2018 13:40'</code> <para>Output </para> <para>-----------------------------</para> <para>VM has been protected.</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <example> <code>Protect-HXVM -ClusterIP 10.198.16.56 -VMName testvm3,testvm4 -GroupName Grp1</code> <para>Output </para> <para>-----------------------------</para> <para>VM has been protected.</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <para type="link">Unprotect-HXVM</para> </member> <member name="P:Cisco.Runbook.ProtectVM.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectVM.VMName"> <summary> <para type="description"> Specify the VM Name to protect an independent VM or list of VM Names to protect by adding it to a protection group. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectVM.VMId"> <summary> <para type="description"> Specify the VM Id to protect an independent VM or list of VM ids to protect by adding it to a protection group. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectVM.GroupName"> <summary> <para type="description"> Specify the exisitng protection group name to which list of VMs has to be added. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectVM.GroupId"> <summary> <para type="description"> Specify the exisitng protection group id to which list of VMs has to be added. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectVM.Interval"> <summary> <para type="description"> Specify the Interval after which the VM will be replicated. Valid values are "5 min", "15 min", "30 min","1 hr","90 min","2 hr", "4 hr", "8 hr", "12 hr", "24 hr" </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectVM.QuiesceUsingTools"> <summary> <para type="description"> Specify the flag if the Quiesce has to be done using tools. Valid value being used is VMTOOLS </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectVM.StartTime"> <summary> <para type="description"> Specify the Start Time after which the VM will be protected. Valid format is M/d/yyyy HH:mm </para> </summary> </member> <member name="M:Cisco.Runbook.ProtectVM.GetStartTimeInEpoch(IO.Swagger.Model.Time)"> <summary> Validate the StartTime entered -it should be less than 24 hours more than current time. </summary> <param name="resClusterTime">Current Cluster Time.</param> <returns>long</returns> </member> <member name="M:Cisco.Runbook.ProtectVM.ValidateParameters"> <summary> Validate the Paramters as per the logic of the cmdlet </summary> <returns>bool</returns> </member> <member name="T:Cisco.Runbook.ProtectGroup"> <summary> <para type="synopsis">Creates the new HX protection group with a schedule.</para> <para type="description">Creates the new HX protection group with a schedule.</para> </summary> <example> <code>C:\> New-HXProtectionGroup Protect-HXGroup -ClusterIP 10.198.14.227 -GroupName DemoGroup1 -Interval '1 hr'</code> <para>Output</para> <para>-----------------------------</para> <para>Protection Group has been created.</para> <para> </para> </example> <example> <code>C:\> New-HXProtectionGroup -ClusterIP 10.198.16.56 -GroupName test8 -Interval '1 hr' -QuiesceUsingTools -StartTime '08/07/2018 08:25'</code> <para>Output</para> <para>-----------------------------</para> <para>Protection Group has been created.</para> <para> </para> </example> <example> <code>C:\> New-HXProtectionGroup -ClusterIP 10.198.16.56 -GroupId 1ef53a37-d4c8-4456-8335-a478dbee572d -Interval '1 hr' -QuiesceUsingTools -StartTime '08/07/2018 08:25'</code> <para>Output</para> <para>-----------------------------</para> <para>Protection Group has been created.</para> <para> </para> </example> <para type="link">Remove-HXProtectionGroup</para> </member> <member name="P:Cisco.Runbook.ProtectGroup.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectGroup.GroupName"> <summary> <para type="description"> Specify the Group Name for the protection group to be created. The group name parameter cannot contain special characters. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectGroup.Interval"> <summary> <para type="description"> Specify the Interval after which the VM will be replicated. Valid values are "5 min", "15 min", "30 min","1 hr","90 min","2 hr", "4 hr", "8 hr", "12 hr", "24 hr" </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectGroup.QuiesceUsingTools"> <summary> <para type="description"> Specify the flag if the Quiesce has to be done using tools. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectGroup.StartTime"> <summary> <para type="description"> Specify the Start Time after which the VM will be protected. Valid format is M/d/yyyy HH:mm . </para> </summary> </member> <member name="M:Cisco.Runbook.ProtectGroup.GetStartTimeInEpoch(IO.Swagger.Model.Time)"> <summary> Validate the StartTime entered -it should be less than 24 hours more than current time. </summary> <param name="resClusterTime">Current Cluster Time.</param> <returns>long</returns> </member> <member name="M:Cisco.Runbook.ProtectGroup.ValidateParameters"> <summary> Validate the Paramters as per the logic of the cmdlet </summary> <returns>bool</returns> </member> <member name="M:Cisco.Runbook.ProtectGroup.HasSpecialChar(System.String)"> <summary> Validate if the group name entered has a special character in it. </summary> <param name="inputName">Group Name entered</param> <returns>bool</returns> </member> <member name="T:Cisco.Runbook.AddProtectedVMToGroup"> <summary> <para type="synopsis">Adds HX protected VMs to a specified group.</para> <para type="description">Adds HX protected VMs to a specified group.</para> </summary> <example> <code>C:\> Add-HXProtectedVMToGroup -ClusterIP 10.198.14.227 -GroupId cc4d1fb0-ce87-4550-a32f-2ed28ead4dad -VMId 421f008c-ee7a-b74a-559c-ad481c119b72 -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>Group Name: DemoGroup </para> <para>Group ID: cc4d1fb0-ce87-4550-a32f-2ed28ead4dad</para> <para>Group ProtectionStatus: ACTIVE</para> <para>Group Members: </para> <para> VM Name: 11 </para> <para> VM ProtectionStatus: ACTIVE</para> <para> VM ID: 421fa002-e68b-a95c-9dbe-ae721b7b2112</para> <para> Source Cluster: skmsrc_711</para> <para> Start Time: 7/15/2018 7:11:54 PM</para> <para> End Time: 7/15/2018 7:11:54 PM</para> <para> BytesReplicated: 2421 </para> <para> --------------------------------------------</para> <para> VM Name: 22 </para> <para> VM ProtectionStatus: ACTIVE</para> <para> VM ID: 421f008c-ee7a-b74a-559c-ad481c119b72</para> <para> Source Cluster: skmsrc_711</para> <para> Start Time: 7/15/2018 7:11:54 PM</para> <para> End Time: 7/15/2018 7:11:54 PM</para> <para> BytesReplicated: 2505 </para> <para> --------------------------------------------</para> <para>Source Cluster: skmsrc_711</para> <para>Target Cluster: skmtgt_711</para> <para>Replication Interval(in Minutes): 5 </para> <para>===================================================</para> <para>BytesReplicated: 2446</para> </example> <example> <code>C:\> Add-HXProtectedVMToGroup -ClusterIP 10.198.5.221 -GroupName grp1 -VMName newvm1</code> <para>Output</para> <para>-----------------------------</para> <para>VM is added to the Group provided.</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <para type="link">Remove-HXProtectedVMFromGroup</para> </member> <member name="P:Cisco.Runbook.AddProtectedVMToGroup.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.AddProtectedVMToGroup.GroupId"> <summary> <para type="description"> Specify exisiting protection group id to which you want to add the VMs. </para> </summary> </member> <member name="P:Cisco.Runbook.AddProtectedVMToGroup.GroupName"> <summary> <para type="description"> Specify exisiting protection group name to which you want to add the VMs. </para> </summary> </member> <member name="P:Cisco.Runbook.AddProtectedVMToGroup.VMName"> <summary> <para type="description"> Specify list of VM names you want to add to the protected group. </para> </summary> </member> <member name="P:Cisco.Runbook.AddProtectedVMToGroup.VMId"> <summary> <para type="description"> Specify list of VM ids you want to add to the protected group. </para> </summary> </member> <member name="P:Cisco.Runbook.AddProtectedVMToGroup.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. </para> </summary> </member> <member name="M:Cisco.Runbook.AddProtectedVMToGroup.WriteGroupRecord(IO.Swagger.Model.ProtectionGroupInfo)"> <summary> Write Group record. </summary> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when null values </exception> <param name="body">Protect VM Spec</param> <returns></returns> </member> <member name="T:Cisco.Runbook.UnprotectVM"> <summary> <para type="synopsis">Unprotects a standalone protected VM.</para> <para type="description">Removes a standalone Protected VM and makes it unprotected. </para> </summary> <example> <code>C:\> Unprotect-HXVM -ClusterIP 10.198.14.229 -VMName DemoVM1</code> <para>Output</para> <para>-----------------------------</para> <para>VM :DemoVM1 has been unprotected.</para> <para> </para> </example> <example> <code>C:\> Unprotect-HXVM -ClusterIP 10.198.14.227 -VMID 421f57c4-ebbd-a64e-a32b-426a251f9f43</code> <para>Output</para> <para>-----------------------------</para> <para>VM :DemoVM2 has been unprotected.</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <para type="link">Protect-HXVM</para> </member> <member name="P:Cisco.Runbook.UnprotectVM.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.UnprotectVM.VMName"> <summary> <para type="description"> Specify the VM Name which has to be removed from protection(or unprotected). </para> </summary> </member> <member name="P:Cisco.Runbook.UnprotectVM.VMID"> <summary> <para type="description"> Specify the VM Name which has to be removed from protection(or unprotected). </para> </summary> </member> <member name="M:Cisco.Runbook.UnprotectVM.ValidateParameters"> <summary> Validate the Paramters as per the logic of the cmdlet </summary> <returns>bool</returns> </member> <member name="T:Cisco.Runbook.UnprotectGroup"> <summary> <para type="synopsis">Removes the group by deleting it.</para> <para type="description">Removes the group by deleting it.All the member VMs become unprotected.</para> </summary> <example> <code>C:\> Remove-HXProtectionGroup -ClusterIP 10.198.14.227 -GroupName DemoGroup1</code> <para>Output</para> <para>-----------------------------</para> <para>This command deletes the Group and the member VMs are unprotected.</para> <para> </para> </example> <example> <code>C:\> Remove-HXProtectionGroup -ClusterIP 10.198.14.227 -GroupID 421f57c4-ebbd-a64e-a32b-426a251f9f43</code> <para>Output</para> <para>-----------------------------</para> <para>This command deletes the Group and the member VMs are unprotected.</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <para type="link">New-HXProtectionGroup</para> </member> <member name="P:Cisco.Runbook.UnprotectGroup.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.UnprotectGroup.GroupID"> <summary> <para type="description"> Specify the Group Id which has to be removed from protection. </para> </summary> </member> <member name="P:Cisco.Runbook.UnprotectGroup.GroupName"> <summary> <para type="description"> Specify the Group name which has to be removed from protection. </para> </summary> </member> <member name="M:Cisco.Runbook.UnprotectGroup.ValidateParameters"> <summary> Validate the Paramters as per the logic of the cmdlet </summary> <returns>bool</returns> </member> <member name="T:Cisco.Runbook.InvokePrepareGroupRecovery"> <summary> <para type="synopsis">Prepares the protection group for recovery.</para> <para type="description">Prepares the protection group for recovery.</para> <para type="description">Since the ProtectionGroup does not have a failover functionality, it will first move out the VMs from the protection group and then perform prepare group recovery on the individual protected VMs.</para> </summary> <example> <code>C:\> Invoke-HXPrepareGroupRecovery -ClusterIP 10.198.14.229 -GroupId 6ed3920a-7fc4-4f92-8da5-814f98f05f5c</code> <para>Output</para> <para>-----------------------------</para> <para>ProtectionStatusV2 : FAILOVERCOMPLETED </para> <para>Er : class EntityRef { </para> <para> Name: Group1 </para> <para> Type: DPVMGROUP </para> <para> Id: 6ed3920a-7fc4-4f92-8da5-814f98f05f5c </para> <para> Idtype: </para> <para> Confignum: 0 </para> <para> } </para> <para> </para> <para>Description : </para> <para>PrimaryEr : class EntityRef { </para> <para> Name: skmsrc_711 </para> <para> Type: CLUSTER </para> <para> Id: 316711787155901742:8013209598152688184</para> <para> Idtype: </para> <para> Confignum: 0 </para> <para> } </para> <para> </para> <para>Members : {} </para> <para>Schedule : {class ReplicationClusterErToSchedule { </para> <para> TargetClusterEr: class EntityRef { </para> <para> Name: skmtgt_711 </para> <para> Type: CLUSTER </para> <para> Id: 196170859791797843:6439004119086246008</para> <para> Idtype: </para> <para> Confignum: 0 </para> <para> } </para> <para> </para> <para> Schedule: class ReplicationSchedule { </para> <para> Enabled: True </para> <para> IntervalInMinutes: 5 </para> <para> StartTime: 1531297344621 </para> <para> QuiesceType: NONE </para> <para> } </para> <para> </para> <para> } </para> <para> } </para> <para>Ex : </para> </example> <para type="link">Get-HXProtectionGroup</para> </member> <member name="P:Cisco.Runbook.InvokePrepareGroupRecovery.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareGroupRecovery.GroupId"> <summary> <para type="description"> Specify the group id on which you want to perform prepare group recovery. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareGroupRecovery.GroupName"> <summary> <para type="description"> Specify the group name on which you want to perform prepare group recovery. </para> </summary> </member> <member name="T:Cisco.Runbook.RemoveProtectedVMFromGroup"> <summary> <para type="synopsis">Removes HX protected VMs from the specified group.</para> <para type="description">Removes HX protected VMs from the specified group.This causes the VMs to become standalone protected VMs.</para> </summary> <example> <code>C:\> Remove-HXProtectedVMFromGroup -ClusterIP 10.198.14.227 -GroupName Group1 -All</code> <para>Output</para> <para>-----------------------------</para> <para>ProtectionStatus : ACTIVE </para> <para>ProtectionStatusV2 : ACTIVE </para> <para>Er : class EntityRef { </para> <para> Name: Group1 </para> <para> Type: DPVMGROUP </para> <para> Id: 6ed3920a-7fc4-4f92-8da5-814f98f05f5c </para> <para> Idtype: </para> <para> Confignum: 0 </para> <para> } </para> <para> </para> <para>Description : </para> <para>PrimaryEr : class EntityRef { </para> <para> Name: skmsrc_711 </para> <para> Type: CLUSTER </para> <para> Id: 316711787155901742:8013209598152688184</para> <para> Idtype: </para> <para> Confignum: 0 </para> <para> } </para> <para> </para> <para>Members : {} </para> <para>Schedule : {class ReplicationClusterErToSchedule { </para> <para> TargetClusterEr: class EntityRef { </para> <para> Name: skmtgt_711 </para> <para> Type: CLUSTER </para> <para> Id: 196170859791797843:6439004119086246008</para> <para> Idtype: </para> <para> Confignum: 0 </para> <para> } </para> <para> </para> <para> Schedule: class ReplicationSchedule { </para> <para> Enabled: True </para> <para> IntervalInMinutes: 5 </para> <para> StartTime: 1531297344621 </para> <para> QuiesceType: NONE </para> <para> } </para> <para> </para> <para> } </para> <para> } </para> <para>Ex :</para> </example> <example> <code>C:\> Remove-HXProtectedVMFromGroup -ClusterIP 10.198.14.227 -GroupId 6ed3920a-7fc4-4f92-8da5-814f98f05f5c -VMName DemoVM1,DemoVM2</code> <para>Output</para> <para>-----------------------------</para> <para>ProtectionStatus : ACTIVE</para> <para>ProtectionStatusV2 : ACTIVE</para> <para>Er : class EntityRef {</para> <para> Name: Group1</para> <para> Type: DPVMGROUP</para> <para> Id: 6ed3920a-7fc4-4f92-8da5-814f98f05f5c</para> <para> Idtype:</para> <para> Confignum: 0</para> <para> }</para> <para></para> <para>Description :</para> <para>PrimaryEr : class EntityRef {</para> <para> Name: skmsrc_711</para> <para> Type: CLUSTER</para> <para> Id: 316711787155901742:8013209598152688184</para> <para> Idtype:</para> <para> Confignum: 0</para> <para> }</para> <para></para> <para>Members : {}</para> <para>Schedule : {class ReplicationClusterErToSchedule {</para> <para> TargetClusterEr: class EntityRef {</para> <para> Name: skmtgt_711</para> <para> Type: CLUSTER</para> <para> Id: 196170859791797843:6439004119086246008</para> <para> Idtype:</para> <para> Confignum: 0</para> <para> }</para> <para></para> <para> Schedule: class ReplicationSchedule {</para> <para> Enabled: True</para> <para> IntervalInMinutes: 5</para> <para> StartTime: 1531297344621</para> <para> QuiesceType: NONE</para> <para> }</para> <para></para> <para> }</para> <para> }</para> <para>Ex :</para> </example> <para type="link">Add-HXProtectedVMToGroup</para> </member> <member name="P:Cisco.Runbook.RemoveProtectedVMFromGroup.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.RemoveProtectedVMFromGroup.GroupId"> <summary> <para type="description"> Specify exisiting protection group id from which you want to remove the VMs. </para> </summary> </member> <member name="P:Cisco.Runbook.RemoveProtectedVMFromGroup.GroupName"> <summary> <para type="description"> Specify exisiting protection group name from which you want to remove the VMs. </para> </summary> </member> <member name="P:Cisco.Runbook.RemoveProtectedVMFromGroup.VMName"> <summary> <para type="description"> Specify list of VM names you want to remove to the protected group. </para> </summary> </member> <member name="P:Cisco.Runbook.RemoveProtectedVMFromGroup.VMId"> <summary> <para type="description"> Specify list of VM ids you want to remove to the protected group. </para> </summary> </member> <member name="P:Cisco.Runbook.RemoveProtectedVMFromGroup.All"> <summary> <para type="description"> Indicates that command will remove all the VMs that exists in the protection group. </para> </summary> </member> <member name="P:Cisco.Runbook.RemoveProtectedVMFromGroup.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. </para> </summary> </member> <member name="M:Cisco.Runbook.RemoveProtectedVMFromGroup.WriteGroupRecord(IO.Swagger.Model.ProtectionGroupInfo)"> <summary> Write Group record. </summary> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when null values </exception> <param name="body">Protect VM Spec</param> <returns></returns> </member> <member name="T:Cisco.Runbook.RecoveryCmdlet"> <summary> This is the base class for all CmdLets, which pulls in the PSCmdLet base class from which all others derive their Cmdletness. </summary> </member> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.RecoveryCmdlet.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job},System.String)" --> <member name="M:Cisco.Runbook.RecoveryCmdlet.getAccessToken(System.String)"> <summary> Get AccessToken </summary> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when fails to make API call</exception> <param name="jobId"></param> <param name="acceptLanguage"> (optional)</param> <param name="accessToken"></param> <returns>ApiResponse of List<Job></returns> </member> <member name="M:Cisco.Runbook.RecoveryCmdlet.WriteErrorRecord(System.Exception,System.String,System.Management.Automation.ErrorCategory,System.String)"> <summary> If the servers PS session variable doesn't exist (no sessions), CmdLet's that require existing sessions can easily check with this method. </summary> </member> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.RecoveryCmdlet.WriteRecoverRecord(System.Collections.Generic.List{IO.Swagger.Model.Job})" --> <member name="M:Cisco.Runbook.RecoveryCmdlet.ValidateParameters"> <summary> Abstract method for parameter validation that is more complex than using the PowerShell parameter validation attributes. </summary> </member> <member name="T:Cisco.Runbook.GetJobStatus"> <summary> <para type="synopsis">Gets the job status for the Protected VM.</para> <para type="description">Gets the job status for the Protected virtual machine.</para> </summary> <example> <code>C:\> Get-HXJobStatus -ClusterIP 10.198.14.227 -VMName DemoVM1 -TaskState All</code> <para>Output</para> <para>-----------------------------</para> <para>This command uses the VMName and TaskState parameter to get the job status for all the tasks that have been performed for the VM given.</para> <para> </para> </example> <example> <code>C:\> Get-HXJobStatus -ClusterIP 10.198.14.227 -VMName DemoVM1 -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>State: COMPLETED</para> <para>Method Name: prepareReverseProtectVm</para> <para>Job ID: 8ae5d2d5-588e-46c1-95c6-08d4d271a5fa</para> <para>Time Started: 7/15/2018 5:52:11 PM</para> <para>Time Elapsed: 7/15/2018 5:52:12 PM</para> <para>Time Submitted: 7/15/2018 5:52:11 PM</para> <para>Lifetime After Exit: 1/8/1970 12:00:00 AM</para> <para>Message: Successfully completed prepareReverseProtect for vm: %s</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <para type="link">Invoke-HXFailover</para> <para type="link">Invoke-HXPrepareFailover</para> <para type="link">Invoke-HXPrepareGroupRecovery</para> <para type="link">Invoke-HXPrepareReverseProtect</para> <para type="link">Invoke-HXTestFailover</para> <para type="link">Invoke-HXReverseProtect </para> </member> <member name="P:Cisco.Runbook.GetJobStatus.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.GetJobStatus.VMID"> <summary> <para type="description"> Specify the VM Id for which the jobs have to displayed. </para> </summary> </member> <member name="P:Cisco.Runbook.GetJobStatus.VMName"> <summary> <para type="description"> Specify the VM Name for which the jobs have to displayed. </para> </summary> </member> <member name="P:Cisco.Runbook.GetJobStatus.JobID"> <summary> <para type="description"> Indicates the Job Id. </para> </summary> </member> <member name="P:Cisco.Runbook.GetJobStatus.TaskName"> <summary> <para type="description"> Indicates the Task Name. Accepted values are "All", "Failover","TestFailover","PrepareFailover","PrepareReverseProtect", "ReverseProtect". </para> </summary> </member> <member name="P:Cisco.Runbook.GetJobStatus.TaskState"> <summary> <para type="description"> Indicates the Task State. Accepted values are "All", "Running", "Completed", "Exception". </para> </summary> </member> <member name="P:Cisco.Runbook.GetJobStatus.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. </para> </summary> </member> <member name="M:Cisco.Runbook.GetJobStatus.ProcessSPRecord"> <summary> Process Record. </summary> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when null values </exception> <returns></returns> </member> <member name="M:Cisco.Runbook.GetJobStatus.WriteTaskrecord(System.Collections.Generic.List{IO.Swagger.Model.Job})"> <summary> Write Task record. </summary> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when null values </exception> <param name="vmTasks">Tasks for each vm</param> <returns></returns> </member> <member name="M:Cisco.Runbook.GetJobStatus.WriteTaskrecord(System.Collections.Generic.List{IO.Swagger.Model.Job},System.String)"> <summary> Write Task record. </summary> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when null values </exception> <param name="vmTasks">Tasks for each vm</param> <returns></returns> </member> <member name="T:Cisco.Runbook.InvokeFailover"> <summary> <para type="synopsis">Performs Failover of the protected VM on the recovery site.</para> <para type="description">Performs Failover of the protected VM on the recovery site.</para> <para type="description">1. Mutual exclusive optional parameters are ResourcePoolName/ResourcePoolId, FolderName/FolderId .</para> <para type="description">2. Incase the source network map is invalid, the VM will failover to default network map setting(s).</para> </summary> <example> <code>C:\> Invoke-HXFailover -VMID 421ffa79-7380-4b72-7bd8-6651b11def58 -PowerOn -ClusterIP 10.198.14.229 -FolderName DemoFolder -NetworkMap "Storage Controller Data Network:VM Network" -Async</code> <para>Output</para> <para>-----------------------------</para> <para>{"taskId":"d92559c6-2396-4757-a500-96ad11820bbd"}</para> <para> </para> </example> <example> <code>C:\> Invoke-HXFailover -VMName DemoVM3 -ClusterIP 10.198.14.229 -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>Failover of VM Completed</para> <para>State: COMPLETED</para> <para>Summary Step State: NOTSTARTED</para> <para>Job ID: 2c611807-260d-45cf-9294-4f93a84204a1</para> <para>Method Name: failoverVm</para> <para>Time Submitted: 7/15/2018 5:44:00 PM</para> <para>Time Started: 7/15/2018 5:44:00 PM</para> <para>Time Elapsed: 7/15/2018 5:44:05 PM</para> <para>Message: Successfully completed %s recovery for VM %s</para> </example> <example> <code>C:\> Invoke-HXFailover -ClusterIP 10.198.5.221 -VMName testvm2 -ResourcePoolName RPName -PowerOn </code> <para>Output</para> <para>-----------------------------</para> <para>Failover of VM Completed in the Resource Pool provided.</para> </example> <para type="link">Invoke-HXPrepareFailover</para> <para type="link">Invoke-HXPrepareGroupRecovery</para> <para type="link">Invoke-HXPrepareReverseProtect</para> <para type="link">Invoke-HXReverseProtect</para> <para type="link">Invoke-HXTestFailover</para> <para type="link">Get-HXJobStatus</para> </member> <member name="P:Cisco.Runbook.InvokeFailover.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.VMID"> <summary> <para type="description"> Specify the VM Id on which failover has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.VMName"> <summary> <para type="description"> Specify the VM Name on which failover has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.ResourcePoolName"> <summary> <para type="description"> Specify the resource pool name. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.ResourcePoolID"> <summary> <para type="description"> Specify the resource pool id. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.FolderName"> <summary> <para type="description"> Specify the folder name. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.FolderID"> <summary> <para type="description"> Specify the folder id. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.NetworkMap"> <summary> <para type="description"> Specify the network mapping.Format is "SourceNetwork1:TargetNetwork1","SourceNetwork2:TargetNetwork2". </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.PowerOn"> <summary> <para type="description"> Indicates if the VM will be powered on/off after failover. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.Async"> <summary> <para type="description"> Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Job Id. To get the status of job please refer to Get-HXJobStatus. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeFailover.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. By default the json would be displayed. </para> </summary> </member> <member name="M:Cisco.Runbook.InvokeFailover.CreatePayload"> <summary> Create PAyload for the API call </summary> <returns>RecoverVmOptions</returns> </member> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.InvokeFailover.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job},System.String)" --> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.InvokeFailover.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job})" --> <member name="M:Cisco.Runbook.InvokeFailover.GetTimeMinutesFromNow"> <summary> gets two minute from the current time </summary> <returns></returns> </member> <member name="T:Cisco.Runbook.InvokeTestFailover"> <summary> <para type="synopsis">Performs test failover of the protected VM.</para> <para type="description">Performs test fail over of the protected VM.</para> <para type="description">1. Mutual exclusive optional parameters are ResourcePoolName/ResourcePoolId, FolderName/FolderId and TestNetwork/Networkmap.</para> <para type="description">2. Incase the source network map is invalid, the VM will failover to default network map setting(s).</para> </summary> <example> <code>C:\> Invoke-HXTestFailover -VMName DemoVM2 -ClusterIP 10.198.14.229 -ResourcePoolName DemoRP -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>Test Failover of VM Completed</para> <para>State: COMPLETED</para> <para>Summary Step State: NOTSTARTED</para> <para>Job ID: 5b1cdaf6-bca9-42a3-b6a8-b1f7d16e7d29</para> <para>Method Name: failoverVm</para> <para>Time Submitted: 7/15/2018 5:39:08 PM</para> <para>Time Started: 7/15/2018 5:39:09 PM</para> <para>Time Elapsed: 7/15/2018 5:39:23 PM</para> <para>Message: Successfully completed %s recovery for VM %s</para> </example> <example> <code>C:\> Invoke-HXTestFailover -VMName DemoVM2 -ClusterIP 10.198.14.229 -FolderName DemoFLDR -Async</code> <para>Output</para> <para>-----------------------------</para> <para>{"taskId":"d92559c6-2396-4757-a500-96ad11820bbd"}</para> </example> <para type="link">Invoke-HXPrepareFailover</para> <para type="link">Invoke-HXPrepareGroupRecovery</para> <para type="link">Invoke-HXPrepareReverseProtect</para> <para type="link">Invoke-HXReverseProtect</para> <para type="link">Invoke-HXTestFailover</para> <para type="link">Get-HXJobStatus</para> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.VMId"> <summary> <para type="description"> Specify the VM Id on which test failover has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.VMName"> <summary> <para type="description"> Specify the VM Name on which test failover has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.ResourcePoolName"> <summary> <para type="description"> Specify the resource pool name. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.ResourcePoolId"> <summary> <para type="description"> Specify the resource pool id. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.FolderName"> <summary> <para type="description"> Specify the folder name. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.FolderID"> <summary> <para type="description"> Specify the folder id. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.TestNetwork"> <summary> <para type="description"> Specify the TestNetwork. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.NetworkMap"> <summary> <para type="description"> Specify the network mapping. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.NewName"> <summary> <para type="description"> Specify the NewName to change the vm name to newname after failover. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.PowerOn"> <summary> <para type="description"> Indicates if the VM will be powered On/Off after Test failover. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.Async"> <summary> <para type="description"> Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Job Id. To get the status of job please refer to Get-HXJotStatus. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeTestFailover.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. </para> </summary> </member> <member name="M:Cisco.Runbook.InvokeTestFailover.CreatePayload"> <summary> Create PAyload for the API call </summary> <returns>RecoverVmOptions</returns> </member> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.InvokeTestFailover.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job})" --> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.InvokeTestFailover.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job},System.String)" --> <member name="M:Cisco.Runbook.InvokeTestFailover.GetTimeMinutesFromNow"> <summary> gets two minute from the current time </summary> <returns></returns> </member> <member name="T:Cisco.Runbook.ConnectCluster"> <summary> <para type="synopsis">Connects to the HX Cluster.</para> <para type="description">Connects to the HX Cluster.</para> </summary> <example> <code>C:\> Connect-HXCluster -ClusterIP 10.198.14.227 -Username root -Password abc</code> <para>Output</para> <para>-----------------------------</para> <para>10.198.14.227 is connected..</para> </example> <para type="link">Disconnect-HXCluster</para> <para type="link">Get-HXCluster</para> </member> <member name="P:Cisco.Runbook.ConnectCluster.Credential"> <summary> <para type="description"> Specify the user's credential for the cluster. </para> </summary> </member> <member name="P:Cisco.Runbook.ConnectCluster.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.ConnectCluster.Username"> <summary> <para type="description"> Specify the username for the HX Cluster. </para> </summary> </member> <member name="P:Cisco.Runbook.ConnectCluster.Password"> <summary> <para type="description"> Specify the password for the HX Cluster. </para> </summary> </member> <member name="M:Cisco.Runbook.ConnectCluster.ProcessSPRecord"> <summary> ProcessRecord </summary> <remarks> </remarks> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when fails to make API call</exception> <returns></returns> </member> <member name="M:Cisco.Runbook.ConnectCluster.ResolveCredentials"> <summary> In case of a regular login, resolve the login credentials and make sure that the Credentials object is not null. </summary> </member> <member name="M:Cisco.Runbook.ConnectCluster.RequirePromptForCredentials"> <summary> Checks to see if we need to prompt for credentials. </summary> <returns><c>true</c> if we must prompt for credentials, <c>false</c> otherwise.</returns> <remarks>If the PSCredential property is null, or if we do not have BOTH a username and a password, this method will return true to its name.</remarks> </member> <member name="T:Cisco.Runbook.DisconnectCluster"> <summary> <para type="synopsis">Disconnects from the HX Cluster.</para> <para type="description">Disconnects from the HX Cluster.</para> </summary> <example> <code>C:\> Disconnect-HXCluster -ClusterIP 10.198.14.227</code> <para>Output</para> <para>-----------------------------</para> <para>10.198.14.227 is disconnected.</para> </example> <para type="link">Connect-HXCluster</para> <para type="link">Get-HXCluster</para> </member> <member name="P:Cisco.Runbook.DisconnectCluster.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="T:Cisco.Runbook.GetProtectedVM"> <summary> <para type="synopsis">Retrieves the HX protected VMs.</para> <para type="description">Retrieves the HX protected VMs.</para> </summary> <example> <code>C:\> Get-HXProtectedVM -ClusterIP 10.198.14.227 -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>VM Name: DemoVM1</para> <para>VM ProtectionStatus: ACTIVE</para> <para>VM ID: 421ffa79-7380-4b72-7bd8-6651b11def58</para> <para>Source Cluster: skmsrc_711</para> <para>Target Cluster: skmtgt_711</para> <para>Replication Interval(in Minutes) : 5</para> <para>Bios Uuid: 421ffa79-7380-4b72-7bd8-6651b11def58</para> <para>Instance Uuid: 501ffa05-293f-0480-b4d3-3de146cb5d30</para> <para>Start Time: 7/15/2018 12:33:58 PM</para> <para>End Time: 7/15/2018 12:33:58 PM</para> <para>BytesReplicated: 2446</para> </example> <example> <code>C:\> Get-HXProtectedVM -ClusterIP 10.198.16.16 -VMName ash2 -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>VM Name: ash2</para> <para>VM ProtectionStatus: PREPAREFAILOVERCOMPLETED</para> <para>VM ID: 422a9cb5-0fef-b30f-ad2d-1004755c50b4</para> <para>Source Cluster: Sample-source</para> <para>Target Cluster: Sample-target</para> <para>Replication Interval(in Minutes) : 5</para> <para>Bios Uuid: 422a9cb5-0fef-b30f-ad2d-1004755c50b4</para> <para>Instance Uuid: 502a615b-36db-d624-fc97-4de6dbe30daa</para> <para>Start Time: 7/15/2018 12:33:58 PM</para> <para>End Time: 7/15/2018 12:33:58 PM</para> <para>BytesReplicated: 2539</para> </example> <example> <code>C:\> Get-HXProtectedVM -ClusterIP 10.198.16.16 -VMName ash* -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>VM Name: ash1</para> <para>VM ProtectionStatus: PREPAREFAILOVERCOMPLETED</para> <para>VM ID: 422a9cb5-0fef-b30f-ad2d-1004755c50b4</para> <para>Source Cluster: Sample-source</para> <para>Target Cluster: Sample-target</para> <para>Replication Interval(in Minutes) : 5</para> <para>Bios Uuid: 422a9cb5-0fef-b30f-ad2d-1004755c50b4</para> <para>Instance Uuid: 502a615b-36db-d624-fc97-4de6dbe30daa</para> <para>Start Time: 7/15/2018 12:33:58 PM</para> <para>End Time: 7/15/2018 12:33:58 PM</para> <para>BytesReplicated: 2539</para> <para>=====================================================================</para> <para>VM Name: ash2</para> <para>VM ProtectionStatus: ACTIVE</para> <para>VM ID: 422a1745-5dc3-d1de-00f0-b50851bb970d</para> <para>Source Cluster: Sample-source</para> <para>Target Cluster: Sample-target</para> <para>Replication Interval(in Minutes) : 5</para> <para>Bios Uuid: 422a9cb5-0fef-b30f-ad2d-1004755c50b4</para> <para>Instance Uuid: 502a615b-36db-d624-fc97-4de6dbe30daa</para> <para>Start Time: 7/15/2018 12:33:58 PM</para> <para>End Time: 7/15/2018 12:33:58 PM</para> <para>BytesReplicated: 2539</para> </example> <para type="link">Get-HXProtectionGroup</para> </member> <member name="P:Cisco.Runbook.GetProtectedVM.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.GetProtectedVM.VMID"> <summary> <para type="description"> Specify the specific VM Id you want to retrieve. </para> </summary> </member> <member name="P:Cisco.Runbook.GetProtectedVM.VMName"> <summary> <para type="description"> Specify the specific VM Name you want to retrieve. </para> </summary> </member> <member name="P:Cisco.Runbook.GetProtectedVM.Direction"> <summary> <para type="description"> Specify the type of VM to limit the search.The valid values are All, Incoming, Outgoing. </para> </summary> </member> <member name="P:Cisco.Runbook.GetProtectedVM.State"> <summary> <para type="description"> Specify the state of VM to limit the search.The valid values are Active, CreationInProgress, CreationFailed, FailoverStarted, FailoverFailed, FailoverCompleted, PrepareFailoverStarted, PrepareFailoverFailed, PrepareFailoverCompleted, PrepareReverseProtectStarted, PrepareReverseProtectFailed, PrepareReverseProtectCompleted, ReverseProtectStarted, ReverseProtectFailed. </para> </summary> </member> <member name="P:Cisco.Runbook.GetProtectedVM.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. </para> </summary> </member> <member name="M:Cisco.Runbook.GetProtectedVM.WriteVMRecord(System.Collections.Generic.List{IO.Swagger.Model.ProtectedVMInfo})"> <summary> Write VM record. </summary> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when null values </exception> <param name="body">Protect VM Spec</param> <returns></returns> </member> <member name="T:Cisco.Runbook.ProtectionGroup"> <summary> <para type="synopsis">Retrieves HX protection groups.</para> <para type="description">Retrieves the HX protection groups.</para> </summary> <example> <code>C:\> Get-HXProtectionGroup -ClusterIP 10.198.14.227 -GroupName ABC -Brief</code> <para>Output</para> <para>----------------------------------------------</para> <para>Group Name: Group1</para> <para>Group ID: 6ed3920a-7fc4-4f92-8da5-814f98f05f5c</para> <para>Group ProtectionStatus: ACTIVE</para> <para>Group Members:</para> <para> VM Name: vm1</para> <para> VM ProtectionStatus: ACTIVE</para> <para> VM ID: 421f57c4-ebbd-a64e-a32b-426a251f9f43</para> <para> Source Cluster: skmsrc_711</para> <para> Start Time: 7/15/2018 1:11:05 PM</para> <para> End Time: 7/15/2018 1:11:06 PM</para> <para> BytesReplicated: 2426</para> <para> -------------------------------------------</para> <para>Source Cluster: skmsrc_711</para> <para>Target Cluster: skmtgt_711</para> <para>Replication Interval(in Minutes): 5</para> </example> <example> <code>C:\> Get-HXProtectionGroup -ClusterIP 10.198.14.227 -Brief</code> <para>Output</para> <para>This example will provide all groups in the the cluster.</para> <para>----------------------------------------------</para> <para>Group Name: ABC</para> <para>Group ID: 6ed3920a-7fc4-4f92-8da5-814f98f05f5c</para> <para>Group ProtectionStatus: ACTIVE</para> <para>Group Members:</para> <para> VM Name: vm1</para> <para> VM ProtectionStatus: ACTIVE</para> <para> VM ID: 421f57c4-ebbd-a64e-a32b-426a251f9f43</para> <para> Source Cluster: skmsrc_711</para> <para> Start Time: 7/15/2018 1:11:05 PM</para> <para> End Time: 7/15/2018 1:11:06 PM</para> <para> BytesReplicated: 2426</para> <para> -------------------------------------------</para> <para>Source Cluster: skmsrc_711</para> <para>Target Cluster: skmtgt_711</para> <para>Replication Interval(in Minutes): 5</para> <para>=====================================================================</para> <para>Group Name: Group1</para> <para>Group ID: c2d26ade-7674-44ab-982e-3bc044292738</para> <para>Group ProtectionStatus: ACTIVE</para> <para>Group Members:</para> <para> VM Name: shaz</para> <para> VM ProtectionStatus: ACTIVE</para> <para> VM ID: 421f57c4-ebbd-a64e-a32b-426a251f9f43</para> <para> Source Cluster: skmsrc_711</para> <para> Start Time: 7/15/2018 1:11:05 PM</para> <para> End Time: 7/15/2018 1:11:06 PM</para> <para> BytesReplicated: 2426</para> <para> -------------------------------------------</para> <para>Source Cluster: skmsrc_711</para> <para>Target Cluster: skmtgt_711</para> <para>Replication Interval(in Minutes): 5</para> </example> <para type="link">Get-HXProtectedVM</para> </member> <member name="P:Cisco.Runbook.ProtectionGroup.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectionGroup.GroupID"> <summary> <para type="description"> Specify the specific protection group id you want to retrieve. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectionGroup.GroupName"> <summary> <para type="description"> Specify the specific protection group name you want to retrieve. </para> </summary> </member> <member name="P:Cisco.Runbook.ProtectionGroup.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. </para> </summary> </member> <member name="M:Cisco.Runbook.ProtectionGroup.WriteGroupRecord(System.Collections.Generic.List{IO.Swagger.Model.ProtectionGroupInfo})"> <summary> Write VM record. </summary> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when null values </exception> <param name="body">Protect VM Spec</param> <returns></returns> </member> <member name="T:Cisco.Runbook.GetCluster"> <summary> <para type="synopsis">Gets the list of connected HX clusters.</para> <para type="description">Gets the list of connected HX clusters.</para> </summary> <example> <code>C:\> Get-HXCluster</code> <para>Output</para> <para>-----------------------------</para> <para>10.198.14.229</para> <para>10.198.14.227</para> </example> <para type="link">Connect-HXCluster</para> <para type="link">Disconnect-HXCluster</para> </member> <member name="T:Cisco.Runbook.InvokePrepareFailover"> <summary> <para type="synopsis">Prepares the protected VM for the failover on the protected site.</para> <para type="description">Prepares the protected VM for the failover on the primary site.</para> </summary> <example> <code>C:\> Invoke-HXPrepareFailover -ClusterIP 10.198.14.227 -VMID 421fcaff-8592-428a-61a7-0181bf0314a3 -Async</code> <para>Output</para> <para>-----------------------------</para> <para>{"taskId":"99a18c1d-23e8-4cf9-aedf-845dc9c832fb"}</para> <para> </para> </example> <example> <code>C:\> Invoke-HXPrepareFailover -ClusterIP 10.198.14.227 -VMID 421f8bbb-540f-11e1-038a-4e66c2ebcc70 -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>Prepare Failover of VM Completed</para> <para>State: COMPLETED</para> <para>Summary Step State: NOTSTARTED</para> <para>Job ID: 2d6c7d49-1ac9-4bc1-9bb7-8a0efa112d1c</para> <para>Method Name: prepareFailoverVm</para> <para>Time Submitted: 7/15/2018 7:02:47 PM</para> <para>Time Started: 7/15/2018 7:02:47 PM</para> <para>Time Elapsed: 7/15/2018 7:02:53 PM</para> <para>Message: Successfully completed prepareFailover for VMID %s</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <para type="link">Invoke-HXFailover</para> <para type="link">Invoke-HXPrepareGroupRecovery</para> <para type="link">Invoke-HXPrepareReverseProtect</para> <para type="link">Invoke-HXReverseProtect</para> <para type="link">Invoke-HXTestFailover</para> <para type="link">Get-HXJobStatus</para> </member> <member name="P:Cisco.Runbook.InvokePrepareFailover.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareFailover.VMID"> <summary> <para type="description"> Specify the VM Id on which Prepare failover has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareFailover.VMName"> <summary> <para type="description"> Specify the VM Name on which test failover has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareFailover.Async"> <summary> <para type="description"> Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Job Id. To get the status of job please refer to Get-HXJobStatus. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareFailover.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. </para> </summary> </member> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.InvokePrepareFailover.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job},System.String)" --> <member name="M:Cisco.Runbook.InvokePrepareFailover.GetTimeMinutesFromNow"> <summary> gets two minute from the current time </summary> <returns></returns> </member> <member name="T:Cisco.Runbook.InvokePrepareReverseProtect"> <summary> <para type="synopsis">Prepares virtual machines for reverse protect on the protected site.</para> <para type="description">Prepares virtual machines for reverse protect on the primary site.</para> </summary> <example> <code>C:\> Invoke-HXPrepareReverseProtect -ClusterIP 10.198.14.227 -VMID 421f0f84-0b3f-fe3a-311c-763f409b3665 -Async</code> <para>Output</para> <para>-----------------------------</para> <para>{"taskId":"99a18c1d-23e8-4cf9-aedf-845dc9c832fb"}</para> <para> </para> </example> <example> <code>C:\> Invoke-HXPrepareReverseProtect -ClusterIP 10.198.14.227 -VMName DemoVM2 -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>Prepare Reverse Protect of VM Completed</para> <para>State: COMPLETED</para> <para>Summary Step State: NOTSTARTED</para> <para>Job ID: 843054d8-11da-47bf-aa05-4ec334dabea6</para> <para>Method Name: prepareReverseProtectVm</para> <para>Time Submitted: 7/15/2018 5:52:27 PM</para> <para>Time Started: 7/15/2018 5:52:27 PM</para> <para>Time Elapsed: 7/15/2018 5:52:28 PM</para> <para>Message: Successfully completed prepareReverseProtect for vm: %s</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <para type="link">Invoke-HXFailover</para> <para type="link">Invoke-HXPrepareGroupRecovery</para> <para type="link">Invoke-HXReverseProtect</para> <para type="link">Invoke-HXTestFailover</para> <para type="link">Get-HXJobStatus</para> </member> <member name="P:Cisco.Runbook.InvokePrepareReverseProtect.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareReverseProtect.VMName"> <summary> <para type="description"> Specify the VM Name on which Prepare Reverse Protect has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareReverseProtect.VMID"> <summary> <para type="description"> Specify the VM Id on which Prepare Reverse Protect has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareReverseProtect.Async"> <summary> <para type="description"> Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Job Id. To get the status of job please refer to Get-HXJobStatus. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokePrepareReverseProtect.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. </para> </summary> </member> <member name="M:Cisco.Runbook.InvokePrepareReverseProtect.GetTimeMinutesFromNow"> <summary> gets two minute from the current time </summary> <returns></returns> </member> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.InvokePrepareReverseProtect.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job})" --> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.InvokePrepareReverseProtect.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job},System.String)" --> <member name="T:Cisco.Runbook.InvokeReverseProtect"> <summary> <para type="synopsis">Reverse protects the virtual machines on the recovery site.</para> <para type="description">Reverse protects the virtual machines after the Failover is complete.</para> </summary> <example> <code>C:\> Invoke-HXReverseProtect -ClusterIP 10.198.14.229 -VMID 421f0f84-0b3f-fe3a-311c-763f409b3665 -Async</code> <para>Output</para> <para>-----------------------------</para> <para>{"taskId":"8d26dfba-ed64-4768-9960-62d40865e51e"}</para> <para> </para> </example> <example> <code>C:\> Invoke-HXReverseProtect -ClusterIP 10.198.14.229 -VMName DemoVM1 -Brief</code> <para>Output</para> <para>-----------------------------</para> <para>Reverse Protect of VM Completed</para> <para>State: COMPLETED</para> <para>Summary Step State: NOTSTARTED</para> <para>Job ID: 5d154cf0-ff85-482a-ae7c-252c0ca324b8</para> <para>Method Name: reverseProtectVm</para> <para>Time Submitted: 7/15/2018 5:57:49 PM</para> <para>Time Started: 7/15/2018 5:57:49 PM</para> <para>Time Elapsed: 7/15/2018 5:57:49 PM</para> <para>Message: Successfully completed reverseProtect for vm: %s</para> <para>----------------------------------------------------------------------</para> <para></para> </example> <para type="link">Invoke-HXFailover</para> <para type="link">Invoke-HXPrepareFailover</para> <para type="link">Invoke-HXPrepareGroupRecovery</para> <para type="link">Invoke-HXPrepareReverseProtect</para> <para type="link">Invoke-HXTestFailover</para> <para type="link">Get-HXJobStatus</para> </member> <member name="P:Cisco.Runbook.InvokeReverseProtect.ClusterIP"> <summary> <para type="description"> Specify the HX Cluster IP. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeReverseProtect.VMName"> <summary> <para type="description"> Specify the VM Name on which Reverse Protect has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeReverseProtect.VMID"> <summary> <para type="description"> Specify the VM Id on which Reverse Protect has to be performed. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeReverseProtect.Async"> <summary> <para type="description"> Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Job Id. To get the status of job please refer to Get-HXJobStatus. </para> </summary> </member> <member name="P:Cisco.Runbook.InvokeReverseProtect.Brief"> <summary> <para type="description"> Indicates that command will return the brief formatted output. </para> </summary> </member> <member name="M:Cisco.Runbook.InvokeReverseProtect.GetTimeMinutesFromNow"> <summary> gets two minute from the current time </summary> <returns></returns> </member> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.InvokeReverseProtect.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job})" --> <!-- Badly formed XML comment ignored for member "M:Cisco.Runbook.InvokeReverseProtect.ShowStatus(System.Collections.Generic.List{IO.Swagger.Model.Job},System.String)" --> <member name="T:Cisco.Runbook.SPCmdlet"> <summary> This is the base class for all CmdLets, which pulls in the PSCmdLet base class from which all others derive their Cmdletness. </summary> </member> <member name="M:Cisco.Runbook.SPCmdlet.getAccessToken(System.String)"> <summary> Get AccessToken </summary> <exception cref="T:IO.Swagger.Client.ApiException">Thrown when fails to make API call</exception> <param name="jobId"></param> <param name="acceptLanguage"> (optional)</param> <param name="accessToken"></param> <returns>ApiResponse of List<Job></returns> </member> <member name="M:Cisco.Runbook.SPCmdlet.WriteErrorRecord(System.Exception,System.String,System.Management.Automation.ErrorCategory,System.String)"> <summary> If the servers PS session variable doesn't exist (no sessions), CmdLet's that require existing sessions can easily check with this method. </summary> </member> <member name="M:Cisco.Runbook.SPCmdlet.ValidateParameters"> <summary> Abstract method for parameter validation that is more complex than using the PowerShell parameter validation attributes. </summary> </member> </members> </doc> |