ucp doc 4.1.2 cli reference guide

Unified Compute Platform 4.1.2UCP DOC CLI Reference Guide

MK-92UCP053-06

© 2014 - 2016 Hitachi Data Systems. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or by any means, electronic ormechanical, including photocopying and recording, or stored in a database or retrieval system forcommercial purposes without the express written permission of Hitachi, Ltd., or Hitachi Data SystemsCorporation (collectively, “Hitachi”). Licensee may make copies of the Materials provided that any suchcopy is: (i) created as an essential step in utilization of the Software as licensed and is used in no othermanner; or (ii) used for archival purposes. Licensee may not make any other copies of the Materials."Materials" mean text, data, photographs, graphics, audio, video and documents.

Hitachi reserves the right to make changes to this Material at any time without notice and assumes noresponsibility for its use. The Materials contain the most current information available at the time ofpublication.

Some of the features described in the Materials might not be currently available. Refer to the most recentproduct announcement for information about feature and product availability, or contact Hitachi DataSystems Corporation at https://support.hds.com/en_us/contact-us.html.

Notice: Hitachi products and services can be ordered only under the terms and conditions of the applicableHitachi agreements. The use of Hitachi products is governed by the terms of your agreements with HitachiData Systems Corporation.

By using this software, you agree that you are responsible for:

1) Acquiring the relevant consents as may be required under local privacy laws or otherwise fromauthorized employees and other individuals to access relevant data; and

2) Verifying that data continues to be held, retrieved, deleted, or otherwise processed in accordance withrelevant laws.

Notice on Export Controls. The technical data and technology inherent in this Document may besubject to U.S. export control laws, including the U.S. Export Administration Act and its associatedregulations, andmay be subject to export or import regulations in other countries. Reader agrees tocomply strictly with all such regulations and acknowledges that Reader has the responsibility to obtainlicenses to export, re-export, or import the Document and any Compliant Products.

Hitachi is a registered trademark of Hitachi, Ltd., in the United States and other countries.

AIX, AS/400e, DB2, Domino, DS6000, DS8000, Enterprise Storage Server, eServer, FICON, FlashCopy,IBM, Lotus, MVS, OS/390, PowerPC, RS6000, S/390, System z9, System z10, Tivoli, z/OS, z9, z10, z13,z/VM, and z/VSE are registered trademarks or trademarks of International Business Machines Corporation.

Active Directory, ActiveX, Bing, Excel, Hyper-V, Internet Explorer, the Internet Explorer logo, Microsoft,the Microsoft Corporate Logo, MS-DOS, Outlook, PowerPoint, SharePoint, Silverlight, SmartScreen, SQLServer, Visual Basic, Visual C++, Visual Studio, Windows, the Windows logo, Windows Azure, WindowsPowerShell, Windows Server, the Windows start button, andWindows Vista are registered trademarks ortrademarks of Microsoft Corporation. Microsoft product screen shots are reprinted with permission fromMicrosoft Corporation.

All other trademarks, service marks, and company names in this document or web site are properties oftheir respective owners.

https://support.hds.com/en_us/contact-us.html

Contents

Preface xixIntended audience xixProduct version xixRelated document xixComments xxGetting help xx

Chapter 1: Introducing the UCPDOCCLI 1Installation 1Connecting to Director Operations Center CLI 1Jobs 2Access and authentication 2

Chapter 2: UCPDirector Operations data types 3Common properties 3DatacenterConfiguration 4UcpDatacenterDirector 4FederationUser 4Role 5RoleType 5UcpInstanceRegistration 5UcpEvent 6UcpJob 6UserPermissionList 6ResourceState 6

Contents iiiUCP DOC CLI Reference Guide

Chapter 3: UCPDisaster Recovery data types 9Common properties 9ReplicatedVolume 10ReplicatedVolumePair 10ReplicationGroup 11SitePair 11TestVolumePair 12

Chapter 4: UCPDOCCommands 13Expand-UCPDatacenterReplicatedVolumePair 13

Syntax 13Description 13Parameters 14-SitePairId <string> 14-ReplicationGroupId <string> 14-ReplicatedVolumePairId <string> 14-VolumeSize <double> 15<CommonParameters> 15

Inputs 15Outputs 15Notes 15Examples 16Example 1 16

Related links 16Export-UCPDatacenterLogBundle 16

Syntax 16Description 16Parameters 17-Id <string> 17-TargetDirectory <string> 17-Force <switchparameter> 17<CommonParameters> 17

Inputs 18Outputs 18Notes 18Examples 18Example 1: Export a log bundle without specifying a target directory 18Example 2: Export a log bundle with a target directory specified 18

iv Contents

UCP DOC CLI Reference Guide

Example 3: Export a log bundle which overwrites by the same file name 19Example 4: Export a log bundle which overwrites by the same file namewithout confirm 19

Related links 19Get-UCPDatacenterConfiguration 20

Syntax 20Description 20Parameters 20<CommonParameters> 20

Inputs 20Outputs 20Notes 20Examples 20Example 1: Gets configuration information of UCP Director OperationsCenter. 20

Related links 21Get-UCPDatacenterDirector 21

Syntax 21Description 21Parameters 21-ComputerName <string> 21-PortNumber <uint32> 21<CommonParameters> 21

Inputs 22Outputs 22Notes 22Examples 22Example 1: Connect to UCP Director Operations Center on local machineat port 444 22Example 2: Connect to UCP Director Operations Center on remotemachine using default port 22

Related links 23Get-UCPDatacenterEvent 23

Syntax 23Description 23Parameters 23-EventId <string> 23-EventType <string> 23-FromDateTime <datetime> 24-JobId <string> 24

Contents vUCP DOC CLI Reference Guide

-Severity <string> 24-TargetId <string> 25-TargetType <string> 25-Relation <string> 25-ToDateTime <datetime> 26<CommonParameters> 26

Inputs 26Outputs 26Notes 26Examples 26Example 1: Get recent events that targeted users 26Example 2: Get recent events that have a relationship to the targetedInstance 27Example 3: Get recent events using relation 'self' 28

Related links 30Get-UCPDatacenterInstance 30

Syntax 30Description 30Parameters 30-InstanceId <string> 30<CommonParameters> 30

Inputs 30Outputs 31Notes 31Examples 31Example 1: Get all registered instances 31Example 2: Get specific registered instance 31

Related links 31Get-UCPDatacenterJob 32

Syntax 32Description 32Parameters 32-FromDateTime <datetime> 32-JobId <string> 32-JobStatus <string> 33-JobType <string> 33-TargetId <string> 33-TargetType <string> 33-Relation <string> 34

vi Contents


-ToDateTime <datetime> 34<CommonParameters> 34

Inputs 35Outputs 35Notes 35Examples 35Example 1: Get Jobs that type is AddUser 35Example 2: Get Jobs that are directly related to the specified target 36

Related links 37Get-UCPDatacenterLogBundleInformation 37

Syntax 37Description 37Parameters 38-Id <string> 38<CommonParameters> 38

Inputs 38Outputs 38Notes 38Examples 38Example 1: List all log bundle informations 38Example 2: Get a log bundle information 40

Related links 40Get-UCPDatacenterMonitorState 41

Syntax 41Description 41Parameters 41-ResourceType <string> 41-ResourceId <string> 41<CommonParameters> 42

Inputs 42Outputs 42Notes 42Examples 42Example 1: Get monitoring state for UCP Director Operations Center. 42Example 2: Get monitoring state for UCP Director Operations Centerbased on Resource Id and ResourceType. 42Example 3: Get monitoring state for UCP Director Operations Centerbased on ResourceType. 43

Related links 43

Contents viiUCP DOC CLI Reference Guide

Get-UCPDatacenterReplicatedVolumePair 43Syntax 43Description 44Parameters 44-SitePairId <string> 44-ReplicationGroupId <string> 44-ReplicatedVolumePairId <string> 44<CommonParameters> 45

Inputs 45Outputs 45Notes 45Examples 45Example 1: Get replicated volume pair 45

Related links 45Get-UCPDatacenterReplicationGroup 46

Syntax 46Description 46Parameters 46-SitePairId <string> 46-ReplicationGroupId <string> 46<CommonParameters> 47

Inputs 47Outputs 47Notes 47Examples 47Example 1: Get all replication groups for a site pair. 47Example 2: Get replication group for a site pair. 47

Related links 48Get-UCPDatacenterRole 48


Inputs 48Outputs 48Notes 49Examples 49Example 1: Get roles for UCP Director Operations Center 49

Related links 49

viii Contents


Get-UCPDatacenterSitePair 49Syntax 49Description 49Parameters 49-SitePairId <string> 49<CommonParameters> 50

Inputs 50Outputs 50Notes 50Examples 50Example 1: Get site pair information for site pair. 50

Related links 50Get-UCPDatacenterTestVolumePair 51

Syntax 51Description 51Parameters 51-SitePairId <string> 51-ReplicationGroupId <string> 51-TestVolumePairId <string> 52<CommonParameters> 52

Inputs 52Outputs 52Notes 52Examples 52Example 1: Get test volume pair 52

Related links 53Get-UCPDatacenterUser 53

Syntax 53Description 53Parameters 53-Id <string> 53<CommonParameters> 53

Inputs 54Outputs 54Notes 54Examples 54Example 1: Get a list of UCP Director Operations Center users and theirrole names. 54Example 2: Gets information about a specific user. 54

Contents ixUCP DOC CLI Reference Guide

Related links 55Get-UCPDatacenterUserPrivileges 55


Inputs 55Outputs 55Notes 56Examples 56Example 1: Get a list of predefined privileges. 56

Related links 56New-UCPDatacenterLogBundle 56

Syntax 56Description 56Parameters 57-Name <string> 57-FromDateTime <datetime> 57-ToDateTime <datetime> 57-CollectJobsAndEvents <switchparameter> 58-TargetJobId <string> 58<CommonParameters> 58

Inputs 59Outputs 59Notes 59Examples 59Example 1: Generate log bundle with specified target job id 59Example 2: Generate log bundle with specified time range andCollectJobsAndEvents 59Example 3: Generate log bundle with default time range 60

Related links 60New-UCPDatacenterReplicatedVolumePair 60

Syntax 60Description 61Parameters 62-SitePairId <string> 62-ReplicationGroupId <string> 62-PrimarySiteId <string> 62-PrimarySiteStorageSystemId <string> 62

x Contents


-SecondarySiteAttachTargetType <string> 63-SecondarySiteAttachTargetId <string> 63-SecondarySiteStorageSystemId <string> 63-VolumesToReplicate <string[]> 64-SecondaryPoolId <string> 64-TestPoolId <string> 64<CommonParameters> 65

Inputs 65Outputs 65Notes 65Examples 65Example 1: Adding new replicated volume to a replication group. 65

Related links 65New-UCPDatacenterReplicationGroup 66

Syntax 66Description 66Parameters 67-Name <string> 67-PrimarySiteId <string> 67-PrimarySiteStorageSystemId <string> 67-SecondarySiteAttachTargetType <string> 67-SecondarySiteAttachTargetId <string> 68-SecondarySiteStorageSystemId <string> 68-SitePairId <string> 68-VolumesToReplicate <string[]> 68-SecondaryPoolId <string> 69-TestVolumeType <testvolumetyperesource> 69-TestPoolId <string> 70<CommonParameters> 70

Inputs 70Outputs 70Notes 70Examples 70Example 1. Create new replication group for site pair. 70

Related links 71New-UCPDatacenterSitePair 71

Syntax 71Description 71Parameters 71

Contents xiUCP DOC CLI Reference Guide

-LeftSiteId <string> 71-MaxOutageToleranceMinutes <string> 72-Name <string> 72-ReplicationMode <replicationmodetype> 72-RightSiteId <string> 72<CommonParameters> 73

Inputs 73Outputs 73Notes 73Examples 73Example 1: Create new site pair with 'TrueCopy' replication mode. 73Example 1: Create new site pair with 'HitachiUniversalReplicator'replication mode. 73

Related links 74New-UcpDatacenterTestVolumePair 74

Syntax 74Description 74Parameters 75-SitePairId <string> 75-ReplicationGroupId <string> 75-TestStoragePoolId <string> 75<CommonParameters> 75

Inputs 76Outputs 76Notes 76Examples 76Example 1: Make new test volumes for a replication group 76

Related links 76New-UCPDatacenterUser 77

Syntax 77Description 77Parameters 77-Name <string> 77-RoleName <roletype> 77<CommonParameters> 78

Inputs 78Outputs 78Notes 78Examples 78

xii Contents


Example 1: Register an AD user with the 'Viewer' role. 78Example 2: Register and AD user with the 'Administrator' role. 78

Related links 79Register-UCPDatacenterInstance 79

Syntax 79Description 79Parameters 79-Credential <pscredential> 79-DisplayName <string> 79-ServiceUrl <string> 80<CommonParameters> 80

Inputs 80Outputs 80Notes 80Examples 80Example 1: Register UCP instance into UCPDatacenter 80

Related links 81Remove-UCPDatacenterLogBundle 81

Syntax 81Description 81Parameters 81-Id <string> 81-Force <switchparameter> 82<CommonParameters> 82

Inputs 82Outputs 82Notes 82Examples 82Example 1: Delete one log bundle 82Example 2: Delete all the log bundles whose status is"ReadyToDownload" 83

Related links 83Remove-UCPDatacenterReplicatedVolumePair 83

Syntax 83Description 83Parameters 83-Force <switchparameter> 83-SitePairId <string> 84-ReplicationGroupId <string> 84

Contents xiiiUCP DOC CLI Reference Guide

-ReplicatedVolumePairId <string> 84<CommonParameters> 84

Inputs 85Outputs 85Notes 85Examples 85Example 1: Remove replicated volume pair. 85

Related links 85Remove-UCPDatacenterReplicationGroup 85

Syntax 85Description 85Parameters 86-Force <switchparameter> 86-SitePairId <string> 86-ReplicationGroupId <string> 86<CommonParameters> 87

Inputs 87Outputs 87Notes 87Examples 87Example 1: Remove replication group from site pair. 87

Related links 87Remove-UCPDatacenterSitePair 87

Syntax 87Description 88Parameters 88-Force <switchparameter> 88-SitePairId <string> 88<CommonParameters> 88

Inputs 88Outputs 89Notes 89Examples 89Example 1: Remove site pair from UCP Director Operations Center. 89

Related links 89Remove-UcpDatacenterTestVolumePair 89

Syntax 89Description 89Parameters 89

xiv Contents


-Force <switchparameter> 89-SitePairId <string> 90-ReplicationGroupId <string> 90<CommonParameters> 90

Inputs 90Outputs 90Notes 90Examples 91Example: Remove test volume pairs for specified replication group. 91

Related links 91Remove-UCPDatacenterUser 91

Syntax 91Description 91Parameters 91-Id <string> 91-Force <switchparameter> 92<CommonParameters> 92

Inputs 92Outputs 92Notes 92Examples 92Example 1: Remove a user from UCP Director Operations Center. 92

Related links 92Set-UCPDatacenterConfiguration 93

Syntax 93Description 93Parameters 93-AmqpUsername <string> 93-AmqpPassword <string> 93<CommonParameters> 94

Inputs 94Outputs 94Notes 94Examples 94Example 1: Modifies the AMQP username and AMQP password of UCPDirector Operations Center. 94

Related links 94Set-UCPDatacenterInstance 94

Syntax 95

Contents xvUCP DOC CLI Reference Guide

Description 95Parameters 95-Credential <pscredential> 95-DisplayName <string> 95-InstanceId <string> 95-ServiceUrl <string> 96<CommonParameters> 96

Inputs 96Outputs 96Notes 96Examples 96Example 1: Update the information of the UCP instance 96

Related links 97Set-UCPDatacenterReplicationGroup 97

Syntax 97Description 97Parameters 97-SitePairId <string> 97-ReplicationGroupId <string> 98-PrimarySiteId <string> 98-PairStatus <string> 98<CommonParameters> 98

Inputs 99Outputs 99Notes 99Examples 99Example 1: Recreate replication on replication group at site pair. 99

Related links 99Set-UCPDatacenterUser 99

Syntax 99Description 99Parameters 100-Id <string> 100-RoleName <roletype[]> 100<CommonParameters> 100

Inputs 100Outputs 100Notes 100Examples 101

xvi Contents


Example 1: Update the user role 101Related links 101

Unregister-UCPDatacenterInstance 101Syntax 101Description 101Parameters 101-InstanceId <string> 101<CommonParameters> 102

Inputs 102Outputs 102Notes 102Examples 102Example 1: Unregister the UCP instance 102

Related links 102Update-UCPDatacenterPlannedFailover 102

Syntax 102Description 103Parameters 103-Force 103-SitePairId <string> 103-ReplicationGroupId <string> 103-PipelineVariable <string> 103<CommonParameters> 104

Inputs 104Outputs 104Notes 104Examples 104Example 1: Perform a planned failover 104

Related links 104Update-UCPDatacenterReplicationDirection 104

Syntax 104Description 104Parameters 105-Force <switchparameter> 105-SitePairId <string> 105-ReplicationGroupId <string> 105<CommonParameters> 105

Inputs 106Outputs 106

Contents xviiUCP DOC CLI Reference Guide

Notes 106Examples 106Related links 106

Update-UCPDatacenterSitePairInventory 106Syntax 106Description 106Parameters 106Inputs 106Outputs 106Example 1: Refreshes UCP Datacenter SitePair inventory 107

Update-UCPDatacenterUnplannedFailover 107Syntax 107Description 107Parameters 107-Force 107-SitePairId <string> 107-ReplicationGroupId <string> 107-PipelineVariable <string> 108<CommonParameters> 108

Inputs 108Outputs 108Notes 108Examples 108Example 1: Perform an unplanned failover 108

Related links 108

xviii Contents


Preface

This guide explains how to use the Hitachi Unified Compute PlatformDirector Operations Center (UCP DOC) CLI.

Intended audienceThe content in this guide is intended for system administrators who use theCLI to administer UCP DOC.

Product versionThis guide applies to release 4.1.2 of UCP.

Related documentThe following documents contain additional information about UCP:

• UCP Pre-Installation Requirements and Configuration Guide —Contains information and procedures you need to be aware of for asuccessful UCP installation.

• UCP Network Architecture and Configuration Guide — Containstechnical reference information about the networking architecture ofUCP systems and provides procedures to help you configure the systemto work in your network environment.

• UCP Director Administrator's Guide — Contains technical and usageinformation for UCP and UCP Director. Describes how to administer UCPDirector through with both VMware vCenter and Microsoft SCVMM.

• UCP Director API Reference Guide — Describes how to use the UCPDirector API.

Preface xixUCP DOC CLI Reference Guide

• UCP Director CLI Reference Guide — Describes how to use the UCPDirector CLI.

• UCP Director Third-Party Copyrights and Licenses — Containscopyright and license information for the third-party softwaredistributed with or embedded in UCP Director.

• UCP DOC Administrator's Guide — Contains technical and usageinformation for Unified Compute Platform Director Operations Center(UCP DOC). Describes how to administer UCP DOC through UCP DOCConsole.

• UCP DOC API Reference Guide — Describes how to use the UCP DOCAPI.

• UCP DOC CLI Reference Guide — Describes how to use the UCP DOCCLI.

CommentsPlease send us your comments on this document:

[email protected]

Include the document title and number, including the revision (forexample, -01), and refer to specific sections and paragraphs wheneverpossible. All comments become the property of Hitachi Data Systems.

Thank you!

Getting helpHitachi Data Systems Support Portal is the destination for technicalsupport of products and solutions sold by Hitachi Data Systems. To contacttechnical support, log on to Hitachi Data Systems Support Connect forcontact information: https://support.hds.com/en_us/contact-us.html.

Hitachi Data Systems Community is a global online community for HDScustomers, partners, independent software vendors, employees, andprospects. It is the destination to get answers, discover insights, and makeconnections. Join the conversation today! Go to community.hds.com,register, and complete your profile.

Comments

xx Preface


mailto:[email protected]



https://community.hds.com/

http://community.hds.com/

Introducing the UCP DOC CLI

UCP DOC is designed to orchestrate across more than one UCP site, referredto as UCP instances. Disaster Recovery CLI is an add-on that providesreplication capabilities between two UCP instances. The UCP DOC CLIprovides full access to UCP DOC features. It allows full scripting support forall standard Director Operations Center CLI and limited scripting supportfor the add-on Disaster Recovery CLI.

InstallationThe UCP DOC CLI installer can be downloaded and installed from the helpmenu in UCP DOC Console. For more information on UCP DOC Console, seethe UCP DOC Administration Manual.

Connecting to Director Operations Center CLIBefore any commands may be used with this PowerShell CLI, theHitachi.UcpDatacenter.CLI snapin must be added to your runspace and aconnection to UCP DOC must be established. You may add the snapin asfollows:

add-pssnapin Hitachi.UcpDatacenter.CLI

Once the snapin is added to your runspace you may establish a connectionto the UCP DOC as follows:

Get-UCPDatacenterDirector ucpdatacenter.ucp.local

Chapter 1: Introducing the UCP DOC CLI 1UCP DOC CLI Reference Guide

1

JobsUCP DOC uses the job code from UCP Director service. So, although thecommands to get jobs and events may be directed at the UCP DOC service,the return data type inherits its construct from UCP Director. The jobs andevents returned by UCP DOC, however, are only the jobs and events relatedto UCP DOC service.

Access and authenticationThere are only two roles for UCP DOC:

• Administrator

• Viewer

2 Chapter 1: Introducing the UCP DOC CLI


Jobs

UCP Director Operations data types

The data types used by commands are created when using Get and Newcommands. They can be modified and piped into Set commands. Updatedversions of these data types are returned from Set commands. They canalso be piped into remove commands to identify the object to be removed.

Common propertiesA few of the UCP DOC CLI data structures have the following commonproperties. These are mentioned here once rather than repeating for eachdata structure which has these properties. Unless otherwise stated, thebelow listed attributes are a part of all data structure.

Name Type Notes

Id String Resource identifier. Use this ID inparameters to specify this resource

InstanceId String The Id of the UCP or UCP DatacenterOperations Center instance. Example:“inst.v2ProductionB-123-456-789”

ResourceType String Type of resource or object

GlobalResourceId String Unique resource identifier across all UCPsite instances. This Id specifies theInstance Id, resource type and the Id ofthe resource and is structured asInstance.Type.Id.

Example: inst.v2ProductionB-123-456-789.hostprofile.hostprofile-59

Chapter 2: UCP Director Operations data types 3UCP DOC CLI Reference Guide

2

DatacenterConfigurationThe contents of this data type are detailed in the following table.

Name Type Notes

AmqpUsername String User name for AMQP

UcpDatacenterDirectorThe contents of this data type are detailed in the following table.

Name Type Notes

ComputerName String Name of the Director OperationsCenter computer.

IsDisasterRecoveryInstalled Boolean Indicates whether disasterrecovery is installed.

PortNumber Int32 Port number for accessing DirectorOperations Center through the webclient.

SerialNumber String Serial number of the DirectorOperations Center installation.

UserName String User name for servicing DirectorOperations Center.

Version String Version of Director OperationsCenter.

FederationUserThe contents of this data type are detailed in the following table.

Name Type Notes

Name String Name for the user

RoleName Collection ofRoleType

Role for the user

4 Chapter 2: UCP Director Operations data types


DatacenterConfiguration

RoleThe contents of this data type are detailed in the following table. The onlycommon property used by this data structure is Id.

Name Type Notes

RoleName RoleType Role for the user. Role Names include:

• Administrator

• Viewer

RoleTypeContains only the string values of Administrator or Viewer.

The Administrator role has permissions:

• UCPDatacenter.SystemAdministration

• UCPDatacenter.View

The Viewer role has only UCPDatacenter.View

UcpInstanceRegistrationThe contents of this data type are detailed in the following table. This datastructure has the common property of Id.

Name Type Notes

DisplayName String Display name of the UCP Instance.

SerialNumber String Serial number of the UCP Instance.

ServiceUrl String URL for accessing the UCP Instance.

UcpId String GlobalId of UCP.

UcpIdType String Resource Type. Always Instance.

UserName String Username for the administrator of theUCP Instance.


Role

UcpEventSee UCPEvent under UCP Director CLI data types.

UcpJobSee UCPJob under UCP Director CLI data types.

UserPermissionListThe contents of this data type are detailed in the following table. This datastructure does not contain the common properties.

Name Type Notes

Permissions String The list of permissionsThe two supportedpermissions are:

• UCPDatacenter.SystemAdministration

• UCPDatacenter.View

ResourceStateThe contents of this data type are detailed in the following table. This datastructure has the common properties of ResourceType andGlobalResourceId.

Name Type Notes

NumErrors Int32 Total count of error messages fromthe monitored resource.

NumOks Int32 Total count of OKmessages from themonitored resource.

NumUnknowns Int32 Total count of Unknown messagesfrom the monitored resource.

NumWarnings Int32 Total count of Warningmessagesfrom the monitored resource.



UcpEvent

Name Type Notes

State String The overall state of the monitoredresource.

SubResources Collection ofResourceState

SubResources are child resources ofthe monitored resource parent.


ResourceState

UCP Disaster Recovery data types

The data types used by commands are created when using Get and Newcommands. They can be modified and piped into Set commands. Updatedversions of these data types are returned from Set commands. They canalso be piped into remove commands to identify the object to be removed.

Common propertiesA few of the UCP Disaster Recovery CLI data structures have the followingcommon properties. These are mentioned here once rather than repeatingfor each data structure which has these properties. Unless otherwise stated,the below listed attributes are a part of all data structures.

Name Type Notes

Id String Resource identifier. Use this ID inparameters to specify this resource

InstanceId String The Id of the UCP or Datacenterinstance. Example:“inst.v2ProductionB-123-456-789”

ResourceType String Type of resource or object

GlobalResourceId String Unique resource identifier across all UCPand Datacenter instances. This Idspecifies the Instance Id, resource typeand the Id of the resource and isstructured as Instance.Type.Id.

Example: inst.v2ProductionB-123-456-789.hostprofile.hostprofile-59

Chapter 3: UCP Disaster Recovery data types 9UCP DOC CLI Reference Guide

3

ReplicatedVolumeThe contents of this data type are detailed in the following table. This datastructure does not have the common properties.

Name Type Notes

VolumeId String Id of the storage system.

StorageSystemId String Id of the volume.

VolumeRole String The role of the volume in the pair.This can be Primary, Secondary orNot Replicated.

ReplicatedVolumePairThe contents of this data type are detailed in the following table.

Name Type Notes

ReplicatedVolumePairId String ID of the volume pair.

ReplicationGroupId String ID of the replication group thatthis volume pair belongs.

PairStatus String Status of replication for thisvolume pair. Values:

COPY: The status reflected whenreplication is taking place

PAIR: The status reflected whenreplication is complete

SIMPLEX: The status reflectedwhen no replication is takingplace

UNCONFIGURED: The statusreflected when the replication isbeing configured

SUSPENDED:When thereplication is suspended

FAILOVER:When the sites are infailover mode

10 Chapter 3: UCP Disaster Recovery data types


ReplicatedVolume

Name Type Notes

ReplicationMode String ReplicationMode StringMode ofreplication: Asynchronous(Hitachi Universal Replication) orSynchronous (True Copy)

CopyPercentComplete Int32 Percent of copy completed.

LeftVolume ReplicatedVolume The first volume in the pair.

RightVolume ReplicatedVolume The second volume in the pair.

ReplicationGroupThe contents of this data type are detailed in the following table.

Name Type Notes

ReplicationGroupId String ID of the replication group.

Name String The name of the replication group.

SitePairId String ID of the site pair.

Status String Status of the replication group.Values:

Consistent: If all the Replicatedvolume pair statuses are consistentand uniquely determine the directionof replication between 2 sites.

Inconsistent: If the direction ofreplication between the 2 sitescannot be determined.

SitePairThe contents of this data type are detailed in the following table.

Name Type Notes

SitePairId String ID of the site pair.

LeftSiteConnectionStatus String The connection status of the firstsite. Connected or Unreachable.

Chapter 3: UCP Disaster Recovery data types 11UCP DOC CLI Reference Guide

ReplicationGroup

Name Type Notes

LeftSiteId String ID of the first site in the site pair.

LeftSitePathGroupStatus String The status of the first site pathgroup.

MaximumOutageTolerance String The maximum outage tolerance forthis site pair. This determines theJournal sizing for asynchronousreplication.

Name String Name of the site pair.

ReplicationType String The type of replication technologyused for all replicated volumesbetween the sites in this pair.Values are:

• Hitachi Universal Replication

• True Copy

RightSiteConnectionStatus String The connection status of the secondsite. Connected or Unreachable.

RightSiteId String ID of the second site in the site pair.

RightSitePathGroupStatus String The status of the second site pathgroup.

TestVolumePairThis data structure is not implemented at this time..

Name Type Notes

SitePairId String Id of the site pair.

ReplicationGroupId String Id of the replication group.

TestVolumePairId String Id of the test volume pair.

12 Chapter 3: UCP Disaster Recovery data types


TestVolumePair

UCP DOC Commands

The PowerShell commands that comprise the UCP DOC CLI are defined inthis chapter. The details found here are also available from the online helpbuilt into the CLI. The CLI provides the standard levels of details that arebuilt into the PowerShell help facility (overview, detailed, examples, andfull).

To get started, after adding the snapin to your runspace you may also listthe commands in the CLI as follows:

Get-Command -Module Hitachi.UCPDOC.cli

Cmdlet names begin with the action that will be taken against the specifiedobject. These include: Expand, Get, New, Register, Remove, Set,Unregister, and Update.

Expand-UCPDatacenterReplicatedVolumePairExpands a replicated volume.

Syntax

Expand-UCPDatacenterReplicatedVolumePair [-SitePairId] <String> [-ReplicationGroupId] <String> [-ReplicatedVolumePairId] <String> [-VolumeSize] <Double> [<CommonParameters>]

Description

Expands the protected volumes, recovery volume and test volumesassociated with the replicated volume pair. This is a multi-step process thatinvolves removing replication between the protected and recovery volumes,as well as removing the replication between the recovery and test volumes.Each volume is then expanded to the new size and replication is then re-

Chapter 4: UCP DOC Commands 13UCP DOC CLI Reference Guide

4

established between the protected and recovery volumes, and between therecovery and test volumes. For Hitachi Universal Replicator, the originaljournals are reused.

A new volume size must be at least 1288490188 bytes greater than theexisting volume size but cannot not exceed 65970693734400 bytes.

Parameters

-SitePairId <string>

The identifier of the site pair. Use Get-UCPDatacenterSitePair to determinethe ID.

Required? True

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? False

-ReplicationGroupId <string>

The identifier of the replication group containing the volume. Use Get-UCPDatacenterReplicationGroup to get the ID.

Required? True

Position? 2

Default value



-ReplicatedVolumePairId <string>

The identifier of the replicated volume to be expanded. Use Get-UCPDatacenterReplicatedVolumePair to get the ID.

Required? True

Position? 3

Default value



14 Chapter 4: UCP DOC Commands


Expand-UCPDatacenterReplicatedVolumePair

-VolumeSize <double>

The new size in bytes of the volume. A new volume size must be at least1288490188 bytes greater than the existing volume size but cannot notexceed 65970693734400 bytes.

Required? True

Position? 4

Default value

Accept pipeline input? false


<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer,PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

Inputs

String

Outputs

Hitachi.UcpDatacenter.CLI.Domain.ReplicatedVolumePair

Notes

Requires UCP Director Operations Center Administrator privilege.


Expand-UCPDatacenterReplicatedVolumePair

http://go.microsoft.com/fwlink/?LinkID=113216

Examples

Example 1

PS C:\> Expand-UCPDatacenterReplicatedVolumePair -SitePairId 1 -ReplicationGroupId payrollRG -

ReplicatedVolumePairId P-payrollRG-12619-14987 -VolumeSize 161061273600

ReplicatedVolumePairId : P-payrollRG-12619-14987

ReplicationGroupId : payrollRG

PairStatus : Pair

ReplicationMode : TrueCopy

CopyPercentComplete : 100

LeftVolume : {VolumeId: 12619, StorageSystemId: 53106, VolumeRole: Primary}

RightVolume : {VolumeId: 14987, StorageSystemId: 53102, VolumeRole: Secondary}

Related links

Get-UCPDatacenterReplicatedVolumePair

Export-UCPDatacenterLogBundleDownload the specified log bundle of UCP Director Operations Center.

Syntax

Export-UCPDatacenterLogBundle [-Id] <String> [-TargetDirectory<String>] [-Force] [<CommonParameters>]

Description

The Export-UCPDatacenterLogBundle cmdlet downloads the specified logbundle of UCP Director Operations Center to the directory path.

A log bundle can be specified by its ID which can be obtained by Get-UCPDatacenterLogBundleInformation cmdlet.

This cmdlet blocks until the download is completed. If you do not need thelog bundle anymore, you can remove it by Remove-UCPDatacenterLogBundle cmdlet.

The name of log bundle is "log bundle name".zip where "log bundle name"was specified at log bundle creation.



Export-UCPDatacenterLogBundle

Parameters

-Id <string>

Specifies Id of a log bundle to be downloaded. Only one log bundle can bedownloaded.

Required? True

Position? 1

Default value



-TargetDirectory <string>

Specifies the download directory where the log bundle file is stored.Argument is the path name of the directory.

Required? False

Position? named

Default value



-Force <switchparameter>

Executes the command without the confirmation prompt.

Required? False

Position? named

Default value



<CommonParameters>





Inputs

String

Outputs

String

Notes

This command requires the UCP DOC View privilege.

Examples

Example 1: Export a log bundle without specifying a target directory

PS C:\> # Generate log bundle$logbundle = New-UCPDatacenterLogBundle -Name "UCPLogBundle-JobId-

5" -TargetJobId 5

# Check current directoryGet-Location

Path----C:\Users\Administrator

# Export log bundleExport-UCPDatacenterLogBundle -Id $logbundle.Id

C:\Users\Administrator\UCPLogBundle-JobId-5.zip

Example 2: Export a log bundle with a target directory specified


5" -TargetJobId 5

# Export a log bundle with a target directory specifiedExport-UCPDatacenterLogBundle -Id $logbundle.Id -TargetDirectory

C:\work

C:\work\UCPLogBundle-JobId-5.zip




Example 3: Export a log bundle which overwrites by the same file name


5" -TargetJobId 5

# Check same file in current directoryGet-ChildItem C:\work

Directory: C:\work

Mode LastWriteTime Length Name---- ------------- ------ -----a--- 9/18/2015 1:19 PM 1434334 UCPLogBundle-JobId-

5.zip

#Export-UCPDatacenterLogBundleExport-UCPDatacenterLogBundle -Id $logbundle.Id -TargetDirectory

C:\work

ConfirmProceed overwriting Log Bundle? (FilePath = C:\work\UCPLogBundle-

JobId-5.zip)[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):y


Example 4: Export a log bundle which overwrites by the same file namewithout confirm


5" -TargetJobId 5

# Export a log bundle which overwrites by the same file namewithout confirm

Export-UCPDatacenterLogBundle -Id $logbundle.Id -TargetDirectoryC:\work -Force


Related links

Get-UCPDatacenterLogBundleInformation



Get-UCPDatacenterConfigurationGets configuration information of UCP Director Operations Center.

Syntax

Get-UCPDatacenterConfiguration [<CommonParameters>]

Description

Gets configuration information of UCP Director Operations Center.

Parameters

<CommonParameters>


Inputs

Outputs

Hitachi.UcpDatacenter.CLI.Domain.DatacenterConfiguration

Notes

This operation requires the UCP Datacenter View privilege to perform.

Examples

Example 1: Gets configuration information of UCP Director OperationsCenter.

PS C:\> Get-UCPDatacenterConfiguration

AmqpUsername : ucpId : 1GlobalResourceId : inst.PODF-FED-12345.dccfg.1ResourceType : DatacenterConfigurationInstanceId : PODF-FED-12345



Get-UCPDatacenterConfiguration


Related links

Set-UCPDatacenterConfiguration

Get-UCPDatacenterDirectorGets a connection to UCP Director Operations Center.

Syntax

Get-UCPDatacenterDirector [[-ComputerName] <String>] [[-PortNumber]<UInt32>] [<CommonParameters>]

Description

Gets a connection to UCP Director Operations Center. The connection isrequired to run other UCP Director Operations Center commands.

Parameters

-ComputerName <string>

Required? False

Position? 1

Default value



-PortNumber <uint32>

Required? False

Position? 2

Default value 443



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer,PipelineVariable, and OutVariable. For more information, see about_


Get-UCPDatacenterDirector

CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

Inputs

None

Outputs

Hitachi.UcpDatacenter.CLI.Domain.UcpDatacenterDirector

Notes

Requires the UCP Director Operations Center Viewer privilege.

Examples

Example 1: Connect to UCP Director Operations Center on local machine atport 444

PS C:\> Get-UCPDatacenterDirector -PortNumber 444

ComputerName : ucpdatacenter.ucp.localPortNumber : 444SerialNumber : DCD-12345UserName : UCP\ucpadminVersion : 3.0.0.0IsDisasterRecoveryInstalled : True

Example 2: Connect to UCP Director Operations Center on remote machineusing default port

PS C:\> Get-UCPDatacenterDirector 10.21.74.249

ComputerName : 10.21.74.249PortNumber : 443SerialNumber : DCD-12345UserName : MCP\user1Version : 3.0.0.3689IsDisasterRecoveryInstalled : True



Get-UCPDatacenterDirector


Related links

Get-UCPDatacenterEventGets UCP Director Operations Center event details.

Syntax

Get-UCPDatacenterEvent [[-EventId] <String>] [-EventType <String>] [-FromDateTime <DateTime>] [-JobId <String>] [-Severity <String>] [-TargetId <String>] [-TargetType <String>] [-Relation <String>] [-ToDateTime <DateTime>] [<CommonParameters>]

Description

Gets UCP Director Operations Center event details. Use optional filterparameters to manage the number of events returned.

Parameters

-EventId <string>

Optional filter that specifies the Id of the UCP Director Operations Centerevent that is to be returned. When present, other optional filter parametersmay not be included.

Required? False

Position? 1

Default value



-EventType <string>

Optional filter that specifies the type of UCP Director Operations Centerevents that are to be returned. Invalid if the EventId parameter is specified.

Required? False

Position? named

Default value



Get-UCPDatacenterEvent


-FromDateTime <datetime>

Optional filter that specifies the beginning date and time of the UCPDirector Operations Center events that are to be returned. Invalid if theEventId parameter is specified. Must be earlier than ToDateTime if thisparameter is present.

Required? False

Position? named

Default value



-JobId <string>

Optional filter that specifies the Id of the associated UCP DirectorOperations Center job. Invalid if the EventId parameter is specified.

Required? False

Position? named

Default value



-Severity <string>

Optional filter that specifies the severity of the UCP Director OperationsCenter events that are to be returned. Invalid if the EventId parameter isspecified.

Possible values for this parameter are Info, Warning, Error

Required? False

Position? named

Default value






-TargetId <string>

Optional filter that specifies the target Id that UCP Director OperationsCenter events that are to be returned. Its use requires TargetType. Invalidif the EventId parameter is specified.

Required? False

Position? named

Default value



-TargetType <string>

Optional filter that specifies the target type of the UCP Director OperationsCenter events that are to be returned. Invalid if the EventId parameter isspecified.

Possible values for this parameter are Instance, Ucp, User, SitePair,ReplicatedGroup, ReplicatedVolumePair

Required? False

Position? named

Default value



-Relation <string>

Optional filter of comma-separated values that must be used with -TargetIdand -TargetType. This specifies which events to return based on therelationship with the given Target.

Possible values are Self and Subcomponent.

Specifying "self" alone is equivalent to omitting the relationship altogether.Specifying Subcomponent will return just those events targeted to sub-components of the given Target. Specifying "Self,Subcomponent" willreturn the union of the former two results.

See the documentation for a full list of all Target Types and their sub-components.



Required? False

Position? named

Default value



-ToDateTime <datetime>

Optional filter that specifies the ending date and time of the UCP DirectorOperations Center events that are to be returned. Invalid if the EventIdparameter is specified. Must be later than FromDateTime if it is present.

Required? False

Position? named

Default value



<CommonParameters>


Inputs

None

Outputs

Hitachi.UCP.CLI.Domain.UcpEvent

Notes

Requires UCP Director Operations Center Viewer privilege.

Examples

Example 1: Get recent events that targeted users

PS C:\> Get-UCPDatacenterEvent -TargetType User





EventId : 2CreatedTime : 9/27/2013 9:53:12 PM +00:00Description : Successfully added user 'podb\administrator'.EventType : AddUserSuccessfulInfoEventJobId : 2Severity : infoTargetId : inst.PODB-FED-12345.user.3TargetType : UserCreatedBy : podb\svc_ucpdcntrRecommendedAction :Id : 2GlobalResourceId : inst.PODB-FED-12345.event.2ResourceType : EventInstanceId : PODB-FED-12345

EventId : 1CreatedTime : 9/27/2013 9:53:03 PM +00:00Description : Successfully added user 'podb\ucpadmin'.EventType : AddUserSuccessfulInfoEventJobId : 1Severity : infoTargetId : inst.PODB-FED-12345.user.2TargetType : UserCreatedBy : podb\svc_ucpdcntrRecommendedAction :Id : 1GlobalResourceId : inst.PODB-FED-12345.event.1ResourceType : EventInstanceId : PODB-FED-12345

Example 2: Get recent events that have a relationship to the targetedInstance

PS C:\> Get-UCPDatacenterEvent -TargetType Instance -TargetIdinst.v2Pod15-123-456-789 -Relation "self, subcomponent" | Select-Object -First 3

EventId : 9CreatedTime : 9/24/2013 3:55:09 AM +00:00Description : Successfully registered UCP instance with URL:

https://10.21.100.6/api.EventType : UCPRegistrationSuccessfulInfoEventJobId : 9Severity : infoTargetId : inst.v2Pod15-123-456-789TargetType : InstanceCreatedBy : UCP\ucpadmin



RecommendedAction :Id : 9GlobalResourceId : inst.pod15-fed-123456.event.9ResourceType : EventInstanceId : pod15-fed-123456

EventId : 8CreatedTime : 9/24/2013 3:54:53 AM +00:00Description : Successfully unregistered UCP instance with

URL: https://10.21.100.6/apEventType : UCPUnregistrationSuccessfulInfoEventJobId : 8Severity : infoTargetId : inst.v2Pod15-123-456-789TargetType : InstanceCreatedBy : UCP\ucpadminRecommendedAction :Id : 8GlobalResourceId : inst.pod15-fed-123456.event.8ResourceType : EventInstanceId : pod15-fed-123456


https://10.21.100.6/api.EventType : UCPRegistrationSuccessfulInfoEventJobId : 7Severity : infoTargetId : inst.v2Pod15-123-456-789TargetType : InstanceCreatedBy : UCP\ucpadminRecommendedAction :Id : 7GlobalResourceId : inst.pod15-fed-123456.event.7ResourceType : EventInstanceId : pod15-fed-123456

Example 3: Get recent events using relation 'self'

PS C:\> Get-UCPDatacenterEvent -TargetType Instance -TargetIdinst.v2Pod15-123-456-789 -Relation self | Select-Object -First 3


https://10.21.100.6/api.




EventType : UCPRegistrationSuccessfulInfoEventJobId : 9Severity : infoTargetId : inst.v2Pod15-123-456-789TargetType : InstanceCreatedBy : UCP\ucpadminRecommendedAction :Id : 9GlobalResourceId : inst.pod15-fed-123456.event.9ResourceType : EventInstanceId : pod15-fed-123456

EventId : 8CreatedTime : 9/24/2013 3:54:53 AM +00:00Description : Successfully unregistered UCP instance with

URL: https://10.21.100.6/api.EventType : UCPUnregistrationSuccessfulInfoEventJobId : 8Severity : infoTargetId : inst.v2Pod15-123-456-789TargetType : InstanceCreatedBy : UCP\ucpadminRecommendedAction :Id : 8GlobalResourceId : inst.pod15-fed-123456.event.8ResourceType : EventInstanceId : pod15-fed-123456


https://10.21.100.6/api.EventType : UCPRegistrationSuccessfulInfoEventJobId : 7Severity : infoTargetId : inst.v2Pod15-123-456-789TargetType : InstanceCreatedBy : UCP\ucpadminRecommendedAction :Id : 7GlobalResourceId : inst.pod15-fed-123456.event.7ResourceType : EventInstanceId : pod15-fed-123456



Related links

Get-UCPDatacenterJob

Get-UCPDatacenterInstanceGets the details of UCP sites.

Syntax

Get-UCPDatacenterInstance [[-InstanceId] <String>][<CommonParameters>]

Description

Returns detailed information about all the UCP sites that are registered withthe UCP Director Operations Center.

Parameters

-InstanceId <string>

Id of the UCP site to return.

Required? False

Position? 1

Default value



<CommonParameters>


Inputs

None



Get-UCPDatacenterInstance


Outputs

Hitachi.UcpDatacenter.CLI.Domain.UcpInstanceRegistration

Notes


Examples

Example 1: Get all registered instances

PS C:\> Get-UCPDatacenterInstance

DisplayName : PodDId : blue-podd-3690SerialNumber : blue-podd-3690ServiceUrl : https://ucpmanagement.podd.local/apiUcpId : inst.blue-podd-3690UcpIdType : InstanceUserName : [email protected]

DisplayName : PodFId : blue-podf-3690SerialNumber : blue-podf-3690ServiceUrl : https://ucpmanagement.podf.local/apiUcpId : inst.blue-podf-3690UcpIdType : InstanceUserName : [email protected]

Example 2: Get specific registered instance

PS C:\> Get-UCPDatacenterInstance -InstanceId blue-podf-3690

DisplayName : PodFId : blue-podf-3690SerialNumber : blue-podf-3690ServiceUrl : https://ucpmanagement.podf.local/apiUcpId : inst.blue-podf-3690UcpIdType : InstanceUserName : [email protected]

Related links

Set-UCPDatacenterInstance



Get-UCPDatacenterJobGets UCP Director Operations Center job details.

Syntax

Get-UCPDatacenterJob [-FromDateTime <DateTime>] [[-JobId] <String>][-JobStatus <String>] [-JobType <String>] [-TargetId <String>] [-TargetType <String>] [-Relation <String>] [-ToDateTime <DateTime>][<CommonParameters>]

Description

Gets UCP Director Operations Center job details. Use optional filterparameters to manage the number of jobs returned.

Parameters


Optional filter that specifies the beginning date and time of the UCPDirector Operations Center jobs that are to be returned. Invalid if the Idparameter is specified. Must be earlier than ToDateTime if it is present.

Required? False

Position? named

Default value



-JobId <string>

Optionally specifies the ID of the UCP Director Operations Center job that isto be returned. When present, optional filter parameters are invalid.

Required? False

Position? 1

Default value






-JobStatus <string>

Optional Filter that specifies the status of the UCP Director OperationsCenter job.

Possible Values are Running, Error, Success.

Required? False

Position? named

Default value



-JobType <string>

Optional filter that specifies the type of UCP Director Operations Center jobsthat are to be returned. Invalid if the Id parameter is specified.

Required? False

Position? named

Default value



-TargetId <string>

Optional filter that specifies the target ID that UCP Director OperationsCenter jobs must have to be returned. Its use requires TargetType. Invalidif the Id parameter is specified.

Required? False

Position? named

Default value



-TargetType <string>

Optional filter that specifies the resource type of the target that UCPDirector Operations Center Jobs must have to be returned. Invalid if the Idparameter is specified.



Possible values for this parameter are Instance, Ucp, User, SitePair,ReplicatedGroup, ReplicatedVolumePair

Required? False

Position? named

Default value



-Relation <string>

Optional filter that specifies the jobs that user wants to retrieve. Users canretrieve jobs for self or jobs targeted to self and all sub components. Forexample - jobs targeted to Ethernet switch, Backups and all Ethernet switchports. Invalid if the Id parameter is specified.

Possible values for this parameter are "self" and "subcomponent".

Required? False

Position? named

Default value




Optional filter that specifies the ending date and time of the UCP DirectorOperations Center jobs that are to be returned. Invalid if the Id parameteris specified. Must be later than FromDateTime if it is present.

Required? False

Position? named

Default value



<CommonParameters>






Inputs

None.

Outputs

Hitachi.UCP.CLI.Domain.UcpJob

Notes


Examples

Example 1: Get Jobs that type is AddUser

PS C:\> Get-UCPDatacenterJob -JobType AddUser

JobId : 2CreatedBy : podb\svc_ucpdcntrEndTime : 9/27/2013 9:53:12 PM +00:00Name : Add User to UCP Director Operations CenterProgress : 100StartTime : 9/27/2013 9:53:12 PM +00:00Status : SuccessTargetId : inst.PODB-FED-12345TargetType : InstanceType : AddUserEvents : {2}Id : 2GlobalResourceId : inst.PODB-FED-12345.job.2ResourceType : JobInstanceId : PODB-FED-12345

JobId : 1CreatedBy : podb\svc_ucpdcntrEndTime : 9/27/2013 9:53:03 PM +00:00Name : Add User to UCP Director Operations CenterProgress : 100StartTime : 9/27/2013 9:53:02 PM +00:00Status : SuccessTargetId : inst.PODB-FED-12345TargetType : Instance




Type : AddUserEvents : {1}Id : 1GlobalResourceId : inst.PODB-FED-12345.job.1ResourceType : JobInstanceId : PODB-FED-12345

Example 2: Get Jobs that are directly related to the specified target

PS C:\> Get-UCPDatacenterJob -TargetType Instance -TargetIdinst.PODB-FED-12345 -Relation self

JobId : 4CreatedBy : podb\administratorEndTime : 9/27/2013 10:26:24 PM +00:00Name : Register UCP Instance with UCP Director Oper-

ations CenterProgress : 100StartTime : 9/27/2013 10:25:48 PM +00:00Status : SuccessTargetId : inst.PODB-FED-12345TargetType : InstanceType : FedUCPInstanceRegistrationJobEvents : {4}Id : 4GlobalResourceId : inst.PODB-FED-12345.job.4ResourceType : JobInstanceId : PODB-FED-12345

JobId : 3CreatedBy : podb\administratorEndTime : 9/27/2013 10:24:53 PM +00:00Name : Register UCP Instance with UCP Director Oper-

ations CenterProgress : 0StartTime : 9/27/2013 10:24:52 PM +00:00Status : ErrorTargetId : inst.PODB-FED-12345TargetType : InstanceType : FedUCPInstanceRegistrationJobEvents : {3}Id : 3GlobalResourceId : inst.PODB-FED-12345.job.3ResourceType : JobInstanceId : PODB-FED-12345

JobId : 2




CreatedBy : podb\svc_ucpdcntrEndTime : 9/27/2013 9:53:12 PM +00:00Name : Add User to UCP Director Operations CenterProgress : 100StartTime : 9/27/2013 9:53:12 PM +00:00Status : SuccessTargetId : inst.PODB-FED-12345TargetType : InstanceType : AddUserEvents : {2}Id : 2GlobalResourceId : inst.PODB-FED-12345.job.2ResourceType : JobInstanceId : PODB-FED-12345

Related links

Get-UCPDatacenterLogBundleInformationGets information of UCP Director Operations Center log bundle(s)

Syntax

Get-UCPDatacenterLogBundleInformation [[-Id] <String>][<CommonParameters>]

Description

Gets UCP Director Operations Center information about log bundle(s). If aId is specified, that log bundle information is returned. Otherwise, all logbundles are returned in an array.

You can confirm the completion of the generation of log bundle in "Status".Each log bundle is identified by the "Id" property in LogBundleInformationobject.

If the status of a log bundle is "ReadyToDownload", then you can start itsdownload by issuing Export-UCPDatacenterLogBundle cmdlet with its Id.



Parameters

-Id <string>

Optionally specifies the ID of the log bundle information that is to bereturned. If not specified, all log bundle informations are returned.

Required? False

Position? 1

Default value



<CommonParameters>


Inputs

None

Outputs

Hitachi.UCP.CLI.Domain.LogCollector

Notes

This command requires the UCP DOC View privilege

Examples

Example 1: List all log bundle informations

PS C:\> Get-UCPDatacenterLogBundleInformation

Name : SampleTest1Status : ReadyToDownloadCreatedDate : 9/8/2015 10:14:05 AM +09:00DownloadUrl : https://ucp-

datacenter.ucp.local:443/api/download/logs/1





FileSizeInKb : 2148.31StartTime : 9/8/2015 10:00:00 AM +09:00EndTime : 9/8/2015 10:13:54 AM +09:00TargetJobId :Id : 1GlobalResourceId : inst.UCPDatacenter-12345.logbundle.1ResourceType : LogBundleInstanceId : UCPDatacenter-12345


datacenter.ucp.local:443/api/download/logs/2FileSizeInKb : 1457.71StartTime :EndTime :TargetJobId : 1Id : 2GlobalResourceId : inst.UCPDatacenter-12345.logbundle.2ResourceType : LogBundleInstanceId : UCPDatacenter-12345




datacenter.ucp.local:443/api/download/logs/4FileSizeInKb : 1654.65StartTime : 9/8/2015 06:00:00 AM +09:00EndTime : 9/8/2015 11:11:39 AM +09:00TargetJobId :



Id : 4GlobalResourceId : inst.UCPDatacenter-12345.logbundle.4ResourceType : LogBundleInstanceId : UCPDatacenter-12345

Name : SampleTest5Status : GeneratingCreatedDate : 9/8/2015 10:21:26 PM +09:00DownloadUrl :FileSizeInKb : 0StartTime : 9/8/2015 10:20:26 AM +09:00EndTime : 9/8/2015 10:21:26 AM +09:00TargetJobId :Id : 5GlobalResourceId : inst.UCPDatacenter-12345.logbundle.5ResourceType : LogBundleInstanceId : UCPDatacenter-12345

Example 2: Get a log bundle information

PS C:\> Get-UCPDatacenterLogBundleInformation -Id 4


datacenter.ucp.local:443/api/download/logs/4FileSizeInKb : 1654.65StartTime : 9/8/2015 06:00:00 AM +09:00EndTime : 9/8/2015 11:11:39 AM +09:00TargetJobId :Id : 4GlobalResourceId : inst.UCPDatacenter-12345.logbundle.4ResourceType : LogBundleInstanceId : UCPDatacenter-12345

Related links

New-UCPDatacenterLogBundle


Remove-UCPDatacenterLogBundle




Get-UCPDatacenterMonitorStateGet the monitor state of every registered instance.

Syntax

Get-UCPDatacenterMonitorState [-ResourceType <String>][<CommonParameters>]

Get-UCPDatacenterMonitorState -ResourceId <String> [-ResourceType<String>] [<CommonParameters>]

Get-UCPDatacenterMonitorState [-ResourceType <String>][<CommonParameters>]

Description

Returns the monitor states and details of every UCP site registered in UCPDirector Operations Center.

Parameters

-ResourceType <string>

Required? False

Position? named

Default value



-ResourceId <string>

Required? True

Position? named

Default value




Get-UCPDatacenterMonitorState

<CommonParameters>


Inputs

None.

Outputs

Hitachi.UcpDatacenter.CLI.Domain.ResourceState

Notes


Examples

Example 1: Get monitoring state for UCP Director Operations Center.

PS C:\> Get-UCPDatacenterMonitorState

GlobalResourceId : inst.v2ProductionB-123-456-789ResourceType : InstanceState : OkNumErrors : 0NumWarnings : 0NumUnknowns : 88NumOks : 141SubResources : {inst.v2ProductionB-123-456-789.eth.1,

inst.v2ProductionB-123-456-789.fc.1,inst.v2ProductionB-123-456-789.cmp.1, inst.v2ProductionB-123-456-

789.stor.1}

Example 2: Get monitoring state for UCP Director Operations Center basedon Resource Id and ResourceType.

PS C:\> Get-UCPDatacenterMonitorState -ResourceId

v2ProductionB-123-456-789 -ResourceType Instance

GlobalResourceId : inst.v2ProductionB-123-456-789



Get-UCPDatacenterMonitorState


ResourceType : InstanceState : WarningNumErrors : 0NumWarnings : 126NumUnknowns : 0NumOks : 244SubResources : {inst.v2ProductionB-123-456-789.eth.1,


789.stor.1}

Example 3: Get monitoring state for UCP Director Operations Center basedon ResourceType.

PS C:\> Get-UCPDatacenterMonitorState -ResourceType Instance

GlobalResourceId : inst.v2ProductionB-123-456-789ResourceType : InstanceState : WarningNumErrors : 0NumWarnings : 126NumUnknowns : 0NumOks : 244SubResources : {inst.v2ProductionB-123-456-789.eth.1,


789.stor.1}

Related links

Get-UCPDatacenterReplicatedVolumePairReturns details about replicated volume pairs.

Syntax

Get-UCPDatacenterReplicatedVolumePair [-SitePairId] <String> [-ReplicationGroupId] <String> [[-ReplicatedVolumePairId] <String>][<CommonParameters>]



Description

Returns details about the replicated volumes in a given replication group. Ifthe ID is specified, it returns the details of a specific replicated volume pair.

Parameters


The identifier of the target site pair. Use Get-UCPDatacenterSitePair todetermine the ID.

Required? True

Position? 1

Default value




The identifier of the replication group containing the replicated volume pair.use Get-UCPDatacenterReplicationGroup to get the ID.

Required? True

Position? 2

Default value




Supply the optional replicated volume pair ID to get details about a specificreplicated volume pair.

Required? False

Position? 3

Default value






<CommonParameters>


Inputs

String

Outputs

Hitachi.UcpDatacenter.CLI.Domain.ReplicatedVolumePair

Notes


Examples

Example 1: Get replicated volume pair

PS C:\> Get-UcpDatacenterReplicatedVolumePair -SitePairId 2 -Rep-licationGroupId PayrollRG

ReplicatedVolumePairId : P-PayrollRG-14977-12554ReplicationGroupId : PayrollRGPairStatus : PairReplicationMode : HitachiUniversalReplicatorCopyPercentComplete : 0LeftVolume : {VolumeId: 14977, StorageSystemId: 53106,

VolumeRole: Primary}RightVolume : {VolumeId: 12554, StorageSystemId: 53102,

VolumeRole: Secondary}

Related links

Get-UCPDatacenterReplicationGroup

Remove-UCPDatacenterReplicatedVolumePair

New-UCPDatacenterReplicatedVolumePair




Get-UCPDatacenterReplicationGroupReturns details about replication groups.

Syntax

Get-UCPDatacenterReplicationGroup [-SitePairId] <String> [[-ReplicationGroupId] <String>] [<CommonParameters>]

Description

Returns the details about the replication groups on the site pair. If the ID isspecified, it returns the details of a specific replication group.

Parameters



Required? True

Position? 1

Default value




The optional identifier of the target replication group. Used to get details ofa specific replication group when more than one replication group exist.

Required? False

Position? 2

Default value






<CommonParameters>


Inputs

None.

Outputs

Hitachi.UcpDatacenter.CLI.Domain.ReplicationGroup

Notes


Examples

Example 1: Get all replication groups for a site pair.

PS C:\> Get-UCPDatacenterReplicationGroup -SitePairId 1

ReplicationGroupId NameSitePairId Status

------------------ ---- ---------- ------

payrollRG payrollRG 1Consistent

InternalWebsite1 InternalWebsite1 1Consistent

BackupFiles BackupFiles 1Consistent

RnDrg1 RnDrg1 1Consistent

RnDrg2 RnDrg2 1Consistent

Example 2: Get replication group for a site pair.

PS C:\> Get-UCPDatacenterReplicationGroup -SitePairId 1 -Rep-licationGroupId payrollRG




ReplicationGroupId NameSitePairId Status

------------------ ---- ---------- ------

payrollRG payrollRG 1Consistent

Related links

New-UCPDatacenterReplicationGroup

Get-UCPDatacenterSitePair

Get-UCPDatacenterRoleGets UCP Director Operations Center roles.

Syntax

Get-UCPDatacenterRole [<CommonParameters>]

Description

Gets a list of roles that UCP Director Operations Center supports.

Parameters

<CommonParameters>


Inputs

None

Outputs

Hitachi.UcpDatacenter.CLI.Domain.Role



Get-UCPDatacenterRole


Notes


Examples

Example 1: Get roles for UCP Director Operations Center

PS C:\> Get-UCPDatacenterRole

Id RoleName-- --------1 Administrator2 Viewer

Related links

Get-UCPDatacenterUserPrivileges

Get-UCPDatacenterSitePairReturns details about site pairs.

Syntax

Get-UCPDatacenterSitePair [[-SitePairId] <String>][<CommonParameters>]

Description

Returns information about all the site pairs. If ID is specified, it returns theinformation about the specific site pair.

Parameters


The optional identifier of the target site pair. Used to get details of a specificsite pair.

Required? False

Position? 1

Default value





<CommonParameters>


Inputs

String

Outputs

Hitachi.UcpDatacenter.CLI.Domain.SitePair

Notes


Examples

Example 1: Get site pair information for site pair.

PS C:\> Get-UCPDatacenterSitePair -SitePairId 1

SitePairId : 1LeftSiteConnectionStatus : ConnectedLeftSiteId : Seattle1LeftSitePathGroupStatus : NormalMaximumOutageTolerance : 30Name : Sea1-Bos1ReplicationType : HitachiUniversalReplicatorRightSiteConnectionStatus : ConnectedRightSiteId : Boston1RightSitePathGroupStatus : Normal

Related links

New-UCPDatacenterSitePair

Remove-UCPDatacenterSitePair





Get-UCPDatacenterTestVolumePairReturns details about test volumes associated to replicated volume pairs.

Syntax

Get-UCPDatacenterTestVolumePair [-SitePairId] <String> [-ReplicationGroupId] <String> [[-TestVolumePairId] <String>][<CommonParameters>]

Description

Returns the details about the test volumes in a given replication group. Ifthe ID is specified, it returns the details of a specific test volume pair.

Parameters



Required? True

Position? 1

Default value




The identifier of the replication group containing the test volume. use Get-UCPDatacenterReplicationGroup to get the ID.

Required? True

Position? 2

Default value




Get-UCPDatacenterTestVolumePair

-TestVolumePairId <string>

Supply the optional test volume pair ID to get details about a specific testvolume pair.

Required? False

Position? 3

Default value



<CommonParameters>


Inputs

String

Outputs

Hitachi.UcpDatacenter.CLI.Domain.TestVolumePair

Notes


Examples

Example 1: Get test volume pair

PS C:\> Get-UCPDatacenterTestVolumePair -SitePairId 11 -Rep-licationGroupId ACKTest

ReplicatedVolumePairId : T-ACKTest-353-356ReplicationGroupId : ACKTestPairStatus : PairReplicationMode : LocalCopyPercentComplete : 100LeftVolume : {VolumeId: 353, StorageSystemId: 210016,



Get-UCPDatacenterTestVolumePair




# To find out the type of test volume, use the volume ID in the UCP Directorcommand Get-UCPVolume. Issue the cmdlet to the secondary UCP site.

Related links



Get-UCPDatacenterUserGets users of UCP Director Operations Center.

Syntax

Get-UCPDatacenterUser [[-Id] <String>] [<CommonParameters>]

Description

Returns a list of UCP Director Operations Center users with role name andID.

Parameters

-Id <string>

Required? False

Position? 1

Default value



<CommonParameters>



Get-UCPDatacenterUser


Inputs

None.

Outputs

Hitachi.UcpDatacenter.CLI.Domain.FederationUser

Notes


Examples

Example 1: Get a list of UCP Director Operations Center users and their rolenames.

PS C:\> Get-UCPDatacenterUser

Name : podb\svc_ucpdcntrRoleName : {Administrator}Id : 1GlobalResourceId : inst.PODF-FED-12345.user.1ResourceType : UserInstanceId : PODF-FED-12345

Name : podb\ucpadminRoleName : {Administrator}Id : 2GlobalResourceId : inst.PODF-FED-12345.user.2ResourceType : UserInstanceId : PODF-FED-12345

Name : podb\administratorRoleName : {Administrator}Id : 3GlobalResourceId : inst.PODF-FED-12345.user.3ResourceType : UserInstanceId : PODF-FED-12345

Example 2: Gets information about a specific user.

PS C:\> Get-UCPDatacenterUser -Id 1





Name : podb\svc_ucpdcntrRoleName : {Administrator}Id : 1GlobalResourceId : inst.PODF-FED-12345.user.1ResourceType : UserInstanceId : PODF-FED-12345

Related links

Set-UCPDatacenterUser

Remove-UCPDatacenterUser

Get-UCPDatacenterUserPrivilegesGets a list of privileges.

Syntax

Get-UCPDatacenterUserPrivileges [<CommonParameters>]

Description

Returns a set of privileges that can be assigned to UCP Director OperationsCenter users.

Parameters

<CommonParameters>


Inputs

None.

Outputs

Hitachi.UCP.CLI.Domain.UserPermissionList


Get-UCPDatacenterUserPrivileges


Notes


Examples

Example 1: Get a list of predefined privileges.

PS C:\> Get-UCPDatacenterUserPrivileges

Permissions-----------{UCPDatacenter.SystemAdministration, UCPDatacenter.View}

Related links

Get-UCPDatacenterRole




New-UCPDatacenterLogBundleGenerate log bundle of UCP Director Operations Center.

Syntax

New-UCPDatacenterLogBundle -Name <String> [-FromDateTime<DateTime>] [-ToDateTime <DateTime>] [-CollectJobsAndEvents][<CommonParameters>]

New-UCPDatacenterLogBundle -Name <String> [-TargetJobId <String>] [-CollectJobsAndEvents] [<CommonParameters>]

Description

The New-UCPDatacenterLogBundle cmdlet generates a new log bundle ofUCP Director Operations Center. This cmdlet collects log items for UCPmanagement block and packs them into one log bundle. The cmdlet waitsfor log bundle generation to complete.




Log bundle contain UCP Datacenter Director services logs. You can also useoptional parameter CollectJobsAndEvents to include UCP DOC Jobs andevents information.

You can focus on a certain time period of the logs by specifying time rangeparameters, "FromDateTime" and "ToDateTime". This is also help to reducethe amount of collected logs.

You can focus on logs related to a certain job by specifying the job ID with"TargetJobId" parameter.

Parameters

-Name <string>

Specifies the name of log bundle to be generated. You can easily identifythe log bundle by its name.

Required? True

Position? named

Default value




Specifies the start time of a time range. Time range is used to narrow downlog.

If this parameter is not specified, the default value is set. Default Value:00:00 of the date when this command is issued (based on client time zone)

Required? False

Position? named

Default value




Specifies the end time of a time range. Time range is used to narrow downlog.



If this parameter is not specified, the default value is set. Default Value:current time(based on client time zone)

Required? False

Position? named

Default value



-CollectJobsAndEvents <switchparameter>

Specifies whether to collect UCP DOC Jobs and UCP Events.

Required? False

Position? named

Default value



-TargetJobId <string>

Specifies the ID of filtering job. You can collect logs related to the specifiedjob ID.

If this parameter is specified, time range (start time and end time pair) isset null.

Required? False

Position? named

Default value



<CommonParameters>






Inputs

String

Outputs

Hitachi.UCP.CLI.Domain.LogCollector

Notes


Examples

Example 1: Generate log bundle with specified target job id

PS C:\> New-UCPDatacenterLogBundle -Name "UCPLogBundle-JobId-5" -Tar-getJobId 5

Name : UCPLogBundle-JobId-5Status : ReadyToDownloadCreatedDate : 10/1/2015 5:31:54 PM +09:00DownloadUrl : https://ucp-


Example 2: Generate log bundle with specified time range andCollectJobsAndEvents

PS C:\> New-UCPDatacenterLogBundle -Name "UCPLogBundle-7Sep-8Sep" -FromDateTime "2015/10/1 06:00:00" -ToDateTime "2015/10/2 10:00:00" -CollectJobsAndEvents

Name : UCPLogBundle-7Sep-8SepStatus : ReadyToDownloadCreatedDate : 10/2/2015 10:00:00 PM +09:00DownloadUrl : https://ucp-

datacenter.ucp.local:443/api/download/logs/5



FileSizeInKb : 2875.84StartTime : 10/1/2015 6:00:00 AM +09:00EndTime : 10/2/2015 10:00:00 AM +09:00TargetJobId :Id : 5GlobalResourceId : inst.UCPDatacenter-12345.logbundle.5ResourceType : LogBundleInstanceId : UCPDatacenter-12345

Example 3: Generate log bundle with default time range

PS C:\> New-UCPDatacenterLogBundle -Name "UCPLogBundle-Today"

Name : UCPLogBundle-TodayStatus : ReadyToDownloadCreatedDate : 10/1/2015 6:34:32 PM +09:00DownloadUrl : https://ucp-

datacenter.ucp.local:443/api/download/logs/6FileSizeInKb : 2874.99StartTime : 10/1/2015 12:00:00 AM +09:00EndTime : 10/1/2015 6:34:32 PM +09:00TargetJobId :Id : 6GlobalResourceId : inst.UCPDatacenter-12345.logbundle.6ResourceType : LogBundleInstanceId : UCPDatacenter-12345

Related links




New-UCPDatacenterReplicatedVolumePairAdds a new replicated volume to a replication group.

Syntax

New-UCPDatacenterReplicatedVolumePair [-SitePairId] <String> [-ReplicationGroupId] <String> [-PrimarySiteId] <String> [-PrimarySiteStorageSystemId] <String> [-




SecondarySiteAttachTargetType] <String> [-SecondarySiteAttachTargetId] <String> [-SecondarySiteStorageSystemId] <String> [-VolumesToReplicate] <String[]> [[-SecondaryPoolId] <String>] [<CommonParameters>]

New-UCPDatacenterReplicatedVolumePair [-SitePairId] <String> [-ReplicationGroupId] <String> [-PrimarySiteId] <String> [-PrimarySiteStorageSystemId] <String> [-SecondarySiteAttachTargetType] <String> [-SecondarySiteAttachTargetId] <String> [-SecondarySiteStorageSystemId] <String> [-VolumesToReplicate] <String[]> [[-TestPoolId] <String>] [<CommonParameters>]

Description

When a new replicated (primary) volume is added, UCP will:

- Create a replication (secondary) volume at the secondary site

- Attach the secondary volume to the specified host or cluster at thesecondary site

- Establish data replication between the two volumes

If the replication group uses test volumes, UCP will:

- Create a test volume of the same type already used by the replicationgroup

- Attach the test volume to the same host or cluster as the secondaryvolume

- Establish replication between the secondary volume and test volume

For Hitachi Universal Replicator configurations, if additional journal space isrequired to support the new overall data change rate, additional journalvolumes will be added to the journal.



Parameters



Required? True

Position? 1

Default value




The identifier of the replication group in which to add the new replicatedvolume pair. use Get-UCPDatacenterReplicationGroup to get the ID.

Required? True

Position? 2

Default value



-PrimarySiteId <string>

The identifier of the site with the volume to protect. Use Get-UCPDatacenterInstance to get the site ID.

Required? True

Position? 3

Default value



-PrimarySiteStorageSystemId <string>

Specifies the ID of the storage system on the site where volumes are to beprotected.

Required? True

Position? 4




Default value



-SecondarySiteAttachTargetType <string>

Specifies a "Server" or "Cluster" for attaching the secondary volume to.Requires also SecondarySiteAttachTargetId.

Required? True

Position? 5

Default value



-SecondarySiteAttachTargetId <string>

The ID of a server or cluster that is already used by the replication group forattaching secondary and test volumes.

Use Get-UCPServer or Get-UCPCluster on UCP Director at the recovery sideof the replication group.

Required? True

Position? 6

Default value



-SecondarySiteStorageSystemId <string>

Specifies the ID of the storage system on the site to host the recoveryvolumes.

Use Get-UCPStorageSystem on UCP Director at the recovery site.

Required? True

Position? 7

Default value





-VolumesToReplicate <string[]>

List of one or more identifiers of the volumes to be replicated.

Use Get-UCPVolume on the UCP Director at the protected site to get thevolume IDs.

Required? True

Position? 8

Default value



-SecondaryPoolId <string>

Optionally specifies the storage pool in which to create the secondaryvolume at the recovery side of the replication group. If not specified, UCPwill automatically select a pool.

Required? False

Position? 9

Default value



-TestPoolId <string>

Optionally specifies the ID of a storage pool in which to create a test volumefor each replicated volume.

Must specify a storage pool type that matches test volumes currently usedby the replication group.

Required? False

Position? 10

Default value






<CommonParameters>


Inputs

Hitachi.UcpDatacenter.CLI.Domain.SitePair,Hitachi.UcpDatacenter.CLI.Domain.ReplicationGroup

Outputs

Notes


Examples

Example 1: Adding new replicated volume to a replication group.

PS C:\> New-UCPDatacenterReplicatedVolumePair -SitePairId 1 -Rep-licationGroupId payrollRG -PrimarySiteId Seattle-1234 -

PrimarySiteStorageSystemId 53000 -SecondarySiteStorageSystemId53001 -SecondarySiteAttachTargetType server -Sec-ondarySiteAttachTargetId d07e233f-b495-11e1-a6fc-8096535cba3e -VolumesToReplicate 11011

ReplicatedVolumePairId : P-payrollRG-11011-64166ReplicationGroupId : payrollRGPairStatus : PairReplicationMode : TrueCopyCopyPercentComplete : 0LeftVolume : {VolumeId: 11011, StorageSystemId: 53000,



Related links






New-UCPDatacenterReplicationGroupCreates a new replication group and sets up replication for the specifiedvolumes.

Syntax

New-UCPDatacenterReplicationGroup [-Name] <String> [-PrimarySiteId]<String> [-PrimarySiteStorageSystemId] <String> [-SecondarySiteAttachTargetType] <String> [-SecondarySiteAttachTargetId] <String> [-SecondarySiteStorageSystemId] <String> [-SitePairId] <String> [-VolumesToReplicate] <String[]> [-SecondaryPoolId] <String>[<CommonParameters>]

New-UCPDatacenterReplicationGroup [-Name] <String> [-PrimarySiteId]<String> [-PrimarySiteStorageSystemId] <String> [-SecondarySiteAttachTargetType] <String> [-SecondarySiteAttachTargetId] <String> [-SecondarySiteStorageSystemId] <String> [-SitePairId] <String> [-VolumesToReplicate] <String[]> [[-TestVolumeType]<TestVolumeTypeResource>] [[-TestPoolId] <String>][<CommonParameters>]

Description

A replication group contains volumes to protect along with their replicatedcopies at the secondary site. The group optionally has test volumes of eithertype Shadow Image or Hitachi Thin Image. Protected volumes later addedto the group will use the same type of test volumes as existing replicatedvolume pairs, if any.

At the replication group level, one UCP Director site is considered primary(or protected), while the other is secondary (or replicated).

When creating a new replication group, specify the host or cluster at thesecondary site to which UCP should attach replicated (and optional test)volumes.




Parameters

-Name <string>

The name to give the new replication group. No special characters areaccepted.

Required? True

Position? 1

Default value




The identifier of the site with the volume to protect. Use Get-UCPDatacenterInstance to get the site ID.

Required? True

Position? 2

Default value



-PrimarySiteStorageSystemId <string>

Specifies the ID of the storage system on the site to be protected.

Required? True

Position? 3

Default value



-SecondarySiteAttachTargetType <string>

Specific "Server" or "Cluster" to define the target type.

Required? True

Position? 4

Default value





-SecondarySiteAttachTargetId <string>

The identifier of the server or cluster. Use Get-UCPServer on the UCPDirector to host the recovery volume to get a server ID. Use Get-UCPClusteron UCP Director to host the recovery volume to get the cluster ID.

Required? True

Position? 5

Default value



-SecondarySiteStorageSystemId <string>

Specifies the ID of the storage system on the site to host the recoveryvolumes.

Use Get-UCPStorageSystem on UCP Director at the secondary site.

Required? True

Position? 6

Default value





Required? True

Position? 7

Default value



-VolumesToReplicate <string[]>

List of one or more volume identifiers to be replicated.




Use Get-UCPVolume on the UCP Director on the protected side to get thevolume ID.

Required? True

Position? 8

Default value



-SecondaryPoolId <string>

Optionally specifies the pool in which to create the secondary (or replicated)volumes.

Required? True

Position? 9

Default value



-TestVolumeType <testvolumetyperesource>

Optionally specifies the TestVolumeType. Acceptable string values are:

- "SI" - Shadow Image. Creates full sized test volumes in an HDP or HDTpool.

- "HTI" - Hitachi Thin Image. Creates virtual test volumes in an HTI pool.

- "None" - Specifies that the replication group will not use test volumes.

When no value is supplied, UCP automatically creates test volumes that areShadow Image.

Required? False

Position? 10

Default value





-TestPoolId <string>

Optionally specifies the storage pool ID in which to create test volumes forthe new replication group.

Must use a pool type that corresponds with the value supplied in theTestVolumeType parameter.

Required? False

Position? 11

Default value



<CommonParameters>


Inputs

String, Hitachi.UcpDatacenter.CLI.Domain.SitePair,

Outputs

None

Notes


Examples

Example 1. Create new replication group for site pair.

PS C:\> New-UCPDatacenterReplicationGroup -Name PayrollRG -PrimarySiteId chicago-site -PrimarySiteStorageSystemId 53106 -Sec-ondarySiteAttachTargetType server -SecondarySiteAttachTargetId03061b51-b391-11e1-8062-b3cf1df7d7fc -SecondarySiteStorageSystemId53102 -SitePairId 2 -VolumesToReplicate PayrollVol1





ReplicationGroupId Name SitePairId Status------------------ ---- ---------- ------PayrollRG PayrollRG 2 Consistent

This command created the replication group called TestRG where theprotected site is chicago-site. The target for the recovery volume is a serverwith storage array ID of 53102 that will host the recovery volumes. The testvolume type will automatically be Shadow Image since the parameterTestVolumeType was not used to specify any other test volume type.

Related links


New-UCPDatacenterSitePairCreates a new site pair.

Syntax

New-UCPDatacenterSitePair -LeftSiteId <String> -MaxOutageToleranceMinutes <String> -Name <String> -ReplicationMode<ReplicationModeType> -RightSiteId <String> [<CommonParameters>]

Description

Creates a new site pair between two sites so that replication can be setupbetween the two sites.

Parameters

-LeftSiteId <string>

The identifier of one of the two sites for the site pair. Use Get-UCPDatacenterInstance to get the site ID.

Required? True

Position? named

Default value





-MaxOutageToleranceMinutes <string>

The number of minutes greater than zero.

Required? True

Position? named

Default value



-Name <string>

A name of which to identify the site pair.

Required? True

Position? named

Default value



-ReplicationMode <replicationmodetype>

This value is either TrueCopy or HitachiUniversalReplicator.

Required? True

Position? named

Default value



-RightSiteId <string>

The identifier of one of the two sites for the site pair. Use Get-UCPDatacenterInstance to get the site ID.

Required? True

Position? named

Default value






<CommonParameters>


Inputs

String

Outputs

Hitachi.UcpDatacenter.CLI.Domain.SitePair

Notes


Examples

Example 1: Create new site pair with 'TrueCopy' replication mode.

PS C:\> New-UCPDatacenterSitePair -LeftSiteId Boston1 -RightSiteIdSeatle1 -MaxOutageToleranceMinutes 0 -ReplicationMode TrueCopy -NameSea-Bos

SitePairId : 2LeftSiteConnectionStatus : ConnectedLeftSiteId : Boston1LeftSitePathGroupStatus : NormalMaximumOutageTolerance : 0Name : Sea-BosReplicationType : TrueCopyRightSiteConnectionStatus : ConnectedRightSiteId : Seattle1RightSitePathGroupStatus : Normal

Example 1: Create new site pair with 'HitachiUniversalReplicator'replication mode.

PS C:\> New-UCPDatacenterSitePair -LeftSiteId Seatle-1234 -RightSiteId Boston-5678 -MaxOutageToleranceMinutes 30 -Rep-licationMode HitachiUniversalReplicator -Name Sea-Bos




SitePairId : 3LeftSiteConnectionStatus : ConnectedLeftSiteId : Seatle-1234LeftSitePathGroupStatus : NormalMaximumOutageTolerance : 30Name : Sea-BosReplicationType : HitachiUniversalReplicatorRightSiteConnectionStatus : ConnectedRightSiteId : Boston-5678RightSitePathGroupStatus : Normal

Related links


New-UcpDatacenterTestVolumePairCreates new test volume(s) for secondary volumes in a replication group.

Syntax

New-UcpDatacenterTestVolumePair [-SitePairId] <String> [-ReplicationGroupId] <String> [-TestStoragePoolId] <String>[<CommonParameters>]

Description

Appropriate for circumstances where:

- The test volumes associated with some of the secondary (replicated)volumes may have been deleted.

- The replication group may not have been built with test volumesoriginally.

In both cases, UCP builds test volumes for each replicated volume that lacksone.

If test volumes do exist for any protected volume in the group, UCP willgenerate new test volumes of the same type; either full sized ShadowImage volumes in an HDP or HDT pool, or Hitachi Thin Image volumes in anHTI pool.



New-UcpDatacenterTestVolumePair

Parameters


The ID of the site pair containing the replication group for which testvolumes should be generated.

Required? True

Position? 1

Default value




The ID of the replication group for which test volumes should be generated.

Required? True

Position? 2

Default value



-TestStoragePoolId <string>

Optionally specifies the ID of a storage pool in which to create test volumes.Job will fail if you specify the ID of a pool that doesn't match the type ofexisting test volumes for the target replication group.

Required? True

Position? 3

Default value



<CommonParameters>





Inputs

Hitachi.UcpDatacenter.CLI.Domain.ReplicationGroup,Hitachi.UcpDatacenter.CLI.Domain.SitePair

Outputs

None

Notes


Examples

Example 1: Make new test volumes for a replication group

PS C:\> New-UcpDatacenterTestVolumePair -SitePairId 11 -Rep-licationGroupId TestTvol1

ReplicatedVolumePairId : T-TestTvol1-144-140ReplicationGroupId : TestTvol1PairStatus : PairReplicationMode : LocalCopyPercentComplete : 100LeftVolume : {VolumeId: 144, StorageSystemId: 310025,



ReplicatedVolumePairId : T-TestTvol1-139-145ReplicationGroupId : TestTvol1PairStatus : PairReplicationMode : LocalCopyPercentComplete : 100LeftVolume : {VolumeId: 139, StorageSystemId: 310025,



# In this example, a TestStoragePoolId is not specified. UCP, by default,creates SI (full sized) test volumes in an HDP pool.

Related links






New-UCPDatacenterUserRegisters user with UCP Director Operations Center and assigns a properrole to the user.

Syntax

New-UCPDatacenterUser [-Name] <String> [-RoleName] <RoleType>[<CommonParameters>]

Description

Registers user with UCP Director Operations Center and assigns a properrole to the user. The role options can be obtained by using Get-UCPDatacenterRole. Only one Role can be assigned per user.

Parameters

-Name <string>

Name of an AD user

Required? True

Position? 1

Default value



-RoleName <roletype>

Role option can found from Get-UCPDatacenterRole cmdlet

Required? True

Position? 2

Default value




New-UCPDatacenterUser

<CommonParameters>


Inputs

String

Outputs


Notes


Examples

Example 1: Register an AD user with the 'Viewer' role.

PS C:\> New-UCPDatacenterUser -Name ucp\user2 -RoleName Viewer

Name : ucp\user2RoleName : {Viewer}Id : 1GlobalResourceId : inst.PODF-FED-12345.user.1ResourceType : UserInstanceId : PODF-FED-12345

Example 2: Register and AD user with the 'Administrator' role.

PS C:\> New-UCPDatacenterUser -Name podb\administrator -RoleNameAdministrator

Name : podb\administratorRoleName : {Administrator}Id : 3GlobalResourceId : inst.PODB-FED-12345.user.3ResourceType : UserInstanceId : PODB-FED-12345



New-UCPDatacenterUser


Related links



Remove-UCPDatacenterUserGet-UCPDatacenterUserPrivileges

Register-UCPDatacenterInstanceRegister new UCP instance into UCPDatacenter.

Syntax

Register-UCPDatacenterInstance -Credential <PSCredential> -DisplayName<String> -ServiceUrl <String> [<CommonParameters>]

Description

Registers a UCP site with UCP Director Operations Center.

Parameters

-Credential <pscredential>

Provide a proper UCP System Administrator user credential.

Required? True

Position? named

Default value



-DisplayName <string>

Name/Label that will represent the UCP instance.

Required? True

Position? named

Default value


Register-UCPDatacenterInstance



-ServiceUrl <string>

URL for reaching UCP Director at a UCP site.

Required? True

Position? named

Default value



<CommonParameters>


Inputs

String

Outputs


Notes


Examples

Example 1: Register UCP instance into UCPDatacenter

PS C:\> Register-UCPDatacenterInstance -Credential $credential -Dis-playName pod15 -ServiceUrl https://10.21.100.6/api

DisplayName : pod15Id : v2Pod15-123-456-789SerialNumber : v2Pod15-123-456-789ServiceUrl : https://10.21.100.6/api



Register-UCPDatacenterInstance


UcpId : inst.v2Pod15-123-456-789UcpIdType : InstanceUserName : [email protected]

Related links

Unregister-UCPDatacenterInstance



Remove-UCPDatacenterLogBundleRemove a log bundle of UCP Director Operations Center.

Syntax

Remove-UCPDatacenterLogBundle [-Id] <String> [-Force][<CommonParameters>]

Description

The Remove-UCPDatacenterLogBundle cmdlet deletes the specified logbundle of UCP Director Operations Center.

The cmdlet prompt you to confirm the deletion for each specified logbundle.

To suppress the confirmation prompt use "Force" parameter.

Parameters

-Id <string>

ID of log bundle to be removed

Required? True

Position? 1

Default value






Executes the command without the confirmation prompt

Required? False

Position? named

Default value



<CommonParameters>


Inputs

String

Outputs

None

Notes


Examples

Example 1: Delete one log bundle

PS C:\> # Generate log bundle$logbundle = New-UCPDatacenterLogBundle -Name "UCPLogBundle-Today"

# Export log bundleExport-UCPDatacenterLogBundle -Id $logbundle.Id -TargetDirectory

C:\work

C:\work\UCPLogBundle-Today.zip

# Delete log bundle





Remove-UCPDatacenterLogBundle -Id $logbundle.Id

ConfirmProceed removing Log Bundle?[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y

Example 2: Delete all the log bundles whose status is "ReadyToDownload"

PS C:\> Get-UCPDatacenterLogBundlesInformation | Where {$_.status -eq"ReadyToDownload" } | Remove-UCPDatacenterLogBundle -Force

Related links


Remove-UCPDatacenterReplicatedVolumePairRemoves the replicated volume pair from a replication group.

Syntax

Remove-UCPDatacenterReplicatedVolumePair [-Force] [-SitePairId]<String> [-ReplicationGroupId] <String> [-ReplicatedVolumePairId]<String> [<CommonParameters>]

Description

Stops replication and removes the replicated volume pair from a replicationgroup.

Parameters


Runs without prompting.

Required? False

Position? named

Default value







Required? True

Position? 1

Default value




The identifier of the replication group containing the target volumes. useGet-UCPDatacenterReplicationGroup to get the ID.

Required? True

Position? 2

Default value




The identifier of the volumes that will have replication removed. Use Get-UCPDatacenterReplicatedVolumePair to get the ID.

Required? True

Position? 3

Default value



<CommonParameters>






Inputs

String

Outputs

None

Notes


Examples

Example 1: Remove replicated volume pair.

PS C:\> Remove-UCPDatacenterReplicatedVolumePair -SiteId 1 -Rep-licationGroupId payrollRG -ReplicatedVolumePairId P-payrollRG-500-600-Force

Related links



Remove-UCPDatacenterReplicationGroupRemoves a replication group and associated replicated volume pairs.

Syntax

Remove-UCPDatacenterReplicationGroup [-Force] [-SitePairId] <String> [-ReplicationGroupId] <String> [<CommonParameters>]

Description

Stops replication and removes the replication group and associatedreplicated volume pairs and test volume pairs. No volumes are removed inthis process. All volumes remain attached to their servers or clusters onboth the protected and recovery sites.


Remove-UCPDatacenterReplicationGroup

For Hitachi Universal Replicator, this operation will remove the journals andfree the associated journal volumes for reuse.

Parameters



Required? False

Position? named

Default value




The identifier of the replication group which will have replication removed.use Get-UCPDatacenterReplicationGroup to get the ID.

Required? True

Position? 1

Default value





Required? True

Position? 2

Default value





Remove-UCPDatacenterReplicationGroup

<CommonParameters>


Inputs

String

Outputs

None

Notes


Examples

Example 1: Remove replication group from site pair.

PS C:\> Remove-UCPDatacenterReplicationGroup 1 payrollRG

ConfirmProceed removing replication group?[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y

Related links


Remove-UCPDatacenterSitePairRemoves the data replication pairing of UCP sites.

Syntax

Remove-UCPDatacenterSitePair [-Force] [-SitePairId] <String>[<CommonParameters>]




Description

When a site pair is removed, replication is stopped between the two sites,and the replicated volumes and test volumes, if any, are deleted. ForHitachi Universal Replicator, the associated journals are also removed.

Parameters



Required? False

Position? named

Default value





Required? True

Position? 1

Default value



<CommonParameters>


Inputs

String





Outputs

Notes


Examples

Example 1: Remove site pair from UCP Director Operations Center.

PS C:\> Remove-UCPDatacenterSitePair -SitePairId 1 -Force

Related links


Remove-UcpDatacenterTestVolumePairRemoves test volumes for an entire replication group.

Syntax

Remove-UcpDatacenterTestVolumePair [-Force] [-SitePairId] <String> [-ReplicationGroupId] <String> [<CommonParameters>]

Description

All test volumes associated with the replication group are deleted.Replicated volumes in the replication group will continue to exist and willmaintain their relationship with primary (protected) volumes.

Parameters


Optional flag. Executes the command without prompting for confirmation.

Required? False

Position? named

Default value




Remove-UcpDatacenterTestVolumePair


ID of the site pair in which to find the replication group to deleted testvolumes for.

Required? True

Position? 1

Default value




ID of the replication group to delete test volumes from.

Required? True

Position? 2

Default value



<CommonParameters>


Inputs

String

Outputs

None

Notes




Remove-UcpDatacenterTestVolumePair


Examples

Example: Remove test volume pairs for specified replication group.

PS C:\> Remove-UcpDatacenterTestVolumePair -Force -SitePairId 1 -Rep-licationGroupId payrollRG

Related links



Remove-UCPDatacenterUserRemoves the user from the UCP Director Operations Center.

Syntax

Remove-UCPDatacenterUser [-Id] <String> [-Force][<CommonParameters>]

Description

Removes the user from the UCP Director Operations Center.

Parameters

-Id <string>

Specifies the ID of the user. Use Get-UCPDatacenterUser to discover theuser ID.

Required? True

Position? 1

Default value






Indicates the user should not be prompted to confirm that the user shouldbe removed.

Required? False

Position? named

Default value



<CommonParameters>


Inputs

Outputs

Notes


Examples

Example 1: Remove a user from UCP Director Operations Center.

PS C:\> Remove-UCPDatacenterUser -Id 2

ConfirmProceed removing datacenter user?[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):

Related links






Set-UCPDatacenterConfigurationModifies the configuration of UCP Director Operations Center.

Syntax

Set-UCPDatacenterConfiguration -AmqpUsername <String> -AmqpPassword <String> [<CommonParameters>]

Description

Modifies the AMQP username and AMQP password of UCP DirectorOperations Center.

Parameters

-AmqpUsername <string>

Specifies the new AMQP username that is to be used to get the monitoringstate of the UCP instance.

Required? True

Position? named

Default value



-AmqpPassword <string>

Specifies the new AMQP password that is to be used to get the monitoringstate of the UCP instance.

Required? True

Position? named

Default value




Set-UCPDatacenterConfiguration

<CommonParameters>


Inputs

Outputs

Hitachi.UcpDatacenter.CLI.Domain.DatacenterConfiguration

Notes


Examples

Example 1: Modifies the AMQP username and AMQP password of UCPDirector Operations Center.

PS C:\> Set-UCPDatacenterConfiguration -AmqpUsername ucp -AmqpPass-word passw0rd

AmqpUsername : ucpId : 1GlobalResourceId : inst.PODF-FED-12345.dccfg.1ResourceType : DatacenterConfigurationInstanceId : PODF-FED-12345

Related links

Get-UCPDatacenterConfiguration

Set-UCPDatacenterInstanceModifies the information of the UCP site.





Syntax

Set-UCPDatacenterInstance -Credential <PSCredential> -DisplayName<String> [-InstanceId] <String> -ServiceUrl <String>[<CommonParameters>]

Description

Modifies the information of the UCP instance registered with UCP DirectorOperations Center.

Parameters

-Credential <pscredential>

Specifies the new username and password that is to be used to manage theUCP instance.

Required? True

Position? named

Default value



-DisplayName <string>

Specifies the new display name that is shown in UCP Director OperationsCenter.

Required? True

Position? named

Default value




Specifies the instance ID of a registered UCP site. Use Get-UCPDatacenterInstance to discover the instance ID.

Required? True



Position? 1

Default value



-ServiceUrl <string>

Specifies the service URL for UCP Director at the specified UCP site.

Required? True

Position? named

Default value



<CommonParameters>


Inputs

String

Outputs


Notes


Examples

Example 1: Update the information of the UCP instance

PS C:\> C:\PS>$cred = Get-CredentialC:\PS>Set-UCPDatacenterInstance -Credential $cred -DisplayName UCP-

01 -InstanceId 1483729 -ServiceUrl https://ucp-management.ucp.local/api





DisplayName : UCP-01Id : 1483729SerialNumber : 1483729ServiceUrl : https://ucpmanagement.ucp.local/apiUcpId : inst.1483729UcpIdType : InstanceUserName : [email protected]

Related links


Set-UCPDatacenterReplicationGroupRecreate replication on a replication group.

Syntax

Set-UCPDatacenterReplicationGroup [-SitePairId] <String> [-ReplicationGroupId] <String> [-PrimarySiteId] <String> [-PairStatus]<String> [<CommonParameters>]

Description

If replicated volume pairs in a replication group are in a suspended statedue to a failed replication link, this command will create or restart thereplication for those replicated volume pairs. The replicated volume pairsthat are in Pair status will not be affected.

Parameters



Required? True

Position? 1

Default value




Set-UCPDatacenterReplicationGroup


The identifier of the replication group of which to force pair andresynchronization. Use Get-UCPDatacenterReplicationGroup to get the ID.

Required? True

Position? 2

Default value




The identifier of the protected site. If some volumes are already in the pairstate and the wrong protected site is given, the job will fail. Use Get-UCPDatacenterInstance to get the site ID.

Required? True

Position? 3

Default value



-PairStatus <string>

PairStatus must always be set to PAIR.

Required? True

Position? 4

Default value



<CommonParameters>




Set-UCPDatacenterReplicationGroup


Inputs

String

Outputs

Hitachi.UcpDatacenter.CLI.Domain.ReplicationGroup

Notes


Examples

Example 1: Recreate replication on replication group at site pair.

PS C:\> Set-UCPDatacenterReplicationGroup -SitePairId 1 -Rep-licationGroupId payrollRG -PrimarySiteId Chicago-5678 -PairStatusPAIR

ReplicationGroupId Name SitePairId Status------------------ ---- ---------- ------payrollRG payrollRG 4 Consistent

Related links


Set-UCPDatacenterUserModifies the user role in the UCP Director Operations Center.

Syntax

Set-UCPDatacenterUser [-Id] <String> [-RoleName] <RoleType[]>[<CommonParameters>]

Description

Modifies the user role in the UCP Director Operations Center.



Parameters

-Id <string>

Specifies the ID of the user. Use Get-UCPDatacenterUser to discover theuser ID.

Required? True

Position? 1

Default value



-RoleName <roletype[]>

Specifies the user role. The supported user roles are Administrator andViewer.

Required? True

Position? 2

Default value



<CommonParameters>


Inputs

String

Outputs


Notes






Examples

Example 1: Update the user role

PS C:\> Set-UCPDatacenterUser -Id 2 -RoleName Administrator

Name : podb\ucpadminRoleName : {Administrator}Id : 2GlobalResourceId : inst.PODB-FED-12345.user.2ResourceType : UserInstanceId : PODB-FED-12345

Related links


Unregister-UCPDatacenterInstanceUnregisters UCP site from UCP Director Operations Center.

Syntax

Unregister-UCPDatacenterInstance [-InstanceId] <String>[<CommonParameters>]

Description

Unregisters UCP site from UCP Director Operations Center.

Parameters


Specifies the instance ID of registered UCP instance. Use Get-UCPDatacenterInstance to discover the instance ID.

Required? True

Position? 1

Default value




Unregister-UCPDatacenterInstance

<CommonParameters>


Inputs

String

Outputs

None

Notes


Examples

Example 1: Unregister the UCP instance

PS C:\> Unregister-UCPDatacenterInstance -InstanceId 1483729

Related links


Update-UCPDatacenterPlannedFailoverPerform a planned failover from one UCP site to a second UCP site

Syntax

Update-UCPDatacenterPlannedFailover [-Force] [-SitePairId] <String> [-ReplicationGroupId] <String> [-PipelineVariable <String>][<CommonParameters>]



Update-UCPDatacenterPlannedFailover


Description

This will begin a planned failover for routine maintenance between tworeplicated pairs.

Parameters

-Force

Required? False

Position? named

Default value

Accept pipeline input? False



Required? True

Position? 1

Default value

Accept pipeline input? True (ByPropertyName)



Required? True

Position? 2

Default value



-PipelineVariable <string>

Required? False

Position? Named

Default value




Update-UCPDatacenterPlannedFailover

<CommonParameters>


Inputs

Outputs

Notes

Examples

Example 1: Perform a planned failover

C:\PS>$SitePair = Get-UCPDatacenterSitePair $ReplicationGroup = Get-UCPDatacenterReplicationGroup -SitePairId $SitePair.Id

C:\PS>$SitePair = Update-UCPDatacenterPlannedFailover -SitePairId$SitePair.SitePairId -ReplicationGroupId $Rep-licationGroup.ReplicationGroupId

ConfirmProceed with planned failover?[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y

Related links

Update-UCPDatacenterReplicationDirection

Syntax

Update-UCPDatacenterReplicationDirection [-Force] [-SitePairId] <String>[-ReplicationGroupId] <String> [<CommonParameters>]

Description

None.





Parameters


Required? False

Position? named

Default value




Required? True

Position? 1

Default value




Required? True

Position? 2

Default value



<CommonParameters>





Inputs

Outputs

Notes

Examples

Related links

Update-UCPDatacenterSitePairInventoryRefreshes UCP Director Operations Center site pair inventory.

Syntax

Update-UCPDatacenterSitePairInventory [<CommonParameters>]

Description

Refreshes UCP DOC site pair inventory.

Parameters

• <CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer,PipelineVariable, and OutVariable. For more information, type, "get-helpabout_commonparameters".

Inputs

None

Outputs

None



Update-UCPDatacenterSitePairInventory

Example 1: Refreshes UCP Datacenter SitePair inventory

C:\PS>Update-UCPDatacenterSitePairInventory

Update-UCPDatacenterUnplannedFailoverPerform a failover from one UCP site to a second UCP site in the case of adisaster

Syntax

Update-UCPDatacenterUnplannedFailover [-Force] [-SitePairId] <String> [-ReplicationGroupId] <String> [-PipelineVariable <String>][<CommonParameters>]

Description

This will begin a failover in the case of a disaster between two replicatedpairs.

Parameters

-Force

Required? False

Position? named

Default value




Required? True

Position? 1

Default value




Required? True


Update-UCPDatacenterUnplannedFailover

Position? 2

Default value



-PipelineVariable <string>

Required? False

Position? Named

Default value



<CommonParameters>


Inputs

Outputs

Notes

Examples

Example 1: Perform an unplanned failover

C:\PS>$SitePair = Get-UCPDatacenterSitePair $ReplicationGroup = Get-UCPDatacenterReplicationGroup -SitePairId $SitePair.Id

C:\PS>$SitePair = Update-UCPDatacenterUnplannedFailover -SitePairId$SitePair.SitePairId -ReplicationGroupId $Rep-licationGroup.ReplicationGroupId

ConfirmProceed with planned failover?[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y

Related links



Update-UCPDatacenterUnplannedFailover


Hitachi Data Systems

Corporate Headquarters2845 Lafayette StreetSanta Clara, California 95050-2627U.S.A.www.hds.com

Regional Contact Information

Americas+1 408 970 [email protected]

Europe, Middle East, and Africa+44 (0) 1753 [email protected]

Asia Pacific+852 3189 [email protected]

MK-92UCP053-06

http://www.hds.com/

http://[email protected]/



ucp doc 4.1.2 cli reference guide

Documents