exports/Invoke-CVModifyReplicationGroup.ps1
|
# ---------------------------------------------------------------------------------- # # Copyright Microsoft Corporation # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ---------------------------------------------------------------------------------- <# .Synopsis Modify the properties of an existing replication group .Description Modify the properties of an existing replication group .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Commvault.Powershell.Models.ICommvaultPowerShellIdentity .Inputs Commvault.Powershell.Models.IUpdateReplicationGroup .Outputs Commvault.Powershell.Models.IGenericResp .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. ADVANCEDOPTIONSCRIPT <IReplicationGroupScript>: Pre/post failover and failback scripts at group level [PostFailbackGuestCredentialsCredentialsName <String>]: username to access the network path [PostFailbackGuestCredentialsCredentialsPassword <String>]: password to access the network path [PostFailbackGuestCredentialsSavedCredentialsId <Int64?>]: [PostFailbackGuestCredentialsSavedCredentialsName <String>]: [PostFailbackGuid <String>]: Unique script identifier string [PostFailbackOSType <String>]: OS types [PostFailbackPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PostFailbackReset <Boolean?>]: On set to true, resets the script to empty [PostFailbackScriptCredentialsCredentialsName <String>]: username to access the network path [PostFailbackScriptCredentialsCredentialsPassword <String>]: password to access the network path [PostFailbackScriptCredentialsSavedCredentialsId <Int64?>]: [PostFailbackScriptCredentialsSavedCredentialsName <String>]: [PostFailbackType <String>]: The type of path being used for DR operation script [PostFailoverGuestCredentialsCredentialsName <String>]: username to access the network path [PostFailoverGuestCredentialsCredentialsPassword <String>]: password to access the network path [PostFailoverGuestCredentialsSavedCredentialsId <Int64?>]: [PostFailoverGuestCredentialsSavedCredentialsName <String>]: [PostFailoverGuid <String>]: Unique script identifier string [PostFailoverOSType <String>]: OS types [PostFailoverPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PostFailoverReset <Boolean?>]: On set to true, resets the script to empty [PostFailoverScriptCredentialsCredentialsName <String>]: username to access the network path [PostFailoverScriptCredentialsCredentialsPassword <String>]: password to access the network path [PostFailoverScriptCredentialsSavedCredentialsId <Int64?>]: [PostFailoverScriptCredentialsSavedCredentialsName <String>]: [PostFailoverType <String>]: The type of path being used for DR operation script [PreFailbackGuestCredentialsCredentialsName <String>]: username to access the network path [PreFailbackGuestCredentialsCredentialsPassword <String>]: password to access the network path [PreFailbackGuestCredentialsSavedCredentialsId <Int64?>]: [PreFailbackGuestCredentialsSavedCredentialsName <String>]: [PreFailbackGuid <String>]: Unique script identifier string [PreFailbackOSType <String>]: OS types [PreFailbackPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PreFailbackReset <Boolean?>]: On set to true, resets the script to empty [PreFailbackScriptCredentialsCredentialsName <String>]: username to access the network path [PreFailbackScriptCredentialsCredentialsPassword <String>]: password to access the network path [PreFailbackScriptCredentialsSavedCredentialsId <Int64?>]: [PreFailbackScriptCredentialsSavedCredentialsName <String>]: [PreFailbackType <String>]: The type of path being used for DR operation script [PreFailoverGuestCredentialsCredentialsName <String>]: username to access the network path [PreFailoverGuestCredentialsCredentialsPassword <String>]: password to access the network path [PreFailoverGuestCredentialsSavedCredentialsId <Int64?>]: [PreFailoverGuestCredentialsSavedCredentialsName <String>]: [PreFailoverGuid <String>]: Unique script identifier string [PreFailoverOSType <String>]: OS types [PreFailoverPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PreFailoverReset <Boolean?>]: On set to true, resets the script to empty [PreFailoverScriptCredentialsCredentialsName <String>]: username to access the network path [PreFailoverScriptCredentialsCredentialsPassword <String>]: password to access the network path [PreFailoverScriptCredentialsSavedCredentialsId <Int64?>]: [PreFailoverScriptCredentialsSavedCredentialsName <String>]: [PreFailoverType <String>]: The type of path being used for DR operation script BODY <IUpdateReplicationGroup>: UpdateReplicationGroupReq [AdvancedOptionContinueOnFailure <Boolean?>]: Set to true to continue to the next priority machines on failure. [AdvancedOptionDelayBetweenPriorityMachines <Int64?>]: The delay between machines in different priorities. Mention in minutes [AdvancedOptionScript <IReplicationGroupScript>]: Pre/post failover and failback scripts at group level [PostFailbackGuestCredentialsCredentialsName <String>]: username to access the network path [PostFailbackGuestCredentialsCredentialsPassword <String>]: password to access the network path [PostFailbackGuestCredentialsSavedCredentialsId <Int64?>]: [PostFailbackGuestCredentialsSavedCredentialsName <String>]: [PostFailbackGuid <String>]: Unique script identifier string [PostFailbackOSType <String>]: OS types [PostFailbackPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PostFailbackReset <Boolean?>]: On set to true, resets the script to empty [PostFailbackScriptCredentialsCredentialsName <String>]: username to access the network path [PostFailbackScriptCredentialsCredentialsPassword <String>]: password to access the network path [PostFailbackScriptCredentialsSavedCredentialsId <Int64?>]: [PostFailbackScriptCredentialsSavedCredentialsName <String>]: [PostFailbackType <String>]: The type of path being used for DR operation script [PostFailoverGuestCredentialsCredentialsName <String>]: username to access the network path [PostFailoverGuestCredentialsCredentialsPassword <String>]: password to access the network path [PostFailoverGuestCredentialsSavedCredentialsId <Int64?>]: [PostFailoverGuestCredentialsSavedCredentialsName <String>]: [PostFailoverGuid <String>]: Unique script identifier string [PostFailoverOSType <String>]: OS types [PostFailoverPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PostFailoverReset <Boolean?>]: On set to true, resets the script to empty [PostFailoverScriptCredentialsCredentialsName <String>]: username to access the network path [PostFailoverScriptCredentialsCredentialsPassword <String>]: password to access the network path [PostFailoverScriptCredentialsSavedCredentialsId <Int64?>]: [PostFailoverScriptCredentialsSavedCredentialsName <String>]: [PostFailoverType <String>]: The type of path being used for DR operation script [PreFailbackGuestCredentialsCredentialsName <String>]: username to access the network path [PreFailbackGuestCredentialsCredentialsPassword <String>]: password to access the network path [PreFailbackGuestCredentialsSavedCredentialsId <Int64?>]: [PreFailbackGuestCredentialsSavedCredentialsName <String>]: [PreFailbackGuid <String>]: Unique script identifier string [PreFailbackOSType <String>]: OS types [PreFailbackPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PreFailbackReset <Boolean?>]: On set to true, resets the script to empty [PreFailbackScriptCredentialsCredentialsName <String>]: username to access the network path [PreFailbackScriptCredentialsCredentialsPassword <String>]: password to access the network path [PreFailbackScriptCredentialsSavedCredentialsId <Int64?>]: [PreFailbackScriptCredentialsSavedCredentialsName <String>]: [PreFailbackType <String>]: The type of path being used for DR operation script [PreFailoverGuestCredentialsCredentialsName <String>]: username to access the network path [PreFailoverGuestCredentialsCredentialsPassword <String>]: password to access the network path [PreFailoverGuestCredentialsSavedCredentialsId <Int64?>]: [PreFailoverGuestCredentialsSavedCredentialsName <String>]: [PreFailoverGuid <String>]: Unique script identifier string [PreFailoverOSType <String>]: OS types [PreFailoverPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PreFailoverReset <Boolean?>]: On set to true, resets the script to empty [PreFailoverScriptCredentialsCredentialsName <String>]: username to access the network path [PreFailoverScriptCredentialsCredentialsPassword <String>]: password to access the network path [PreFailoverScriptCredentialsSavedCredentialsId <Int64?>]: [PreFailoverScriptCredentialsSavedCredentialsName <String>]: [PreFailoverType <String>]: The type of path being used for DR operation script [Disable <Boolean?>]: Used to disable a replication group [Enable <Boolean?>]: Used to enable a replication group [NewName <String>]: Used to change the name of a replication group INPUTOBJECT <ICommvaultPowerShellIdentity>: Identity Parameter [AccessPathId <Int64?>]: Id of the mount path whose access path has to be deleted [AgentId <Int64?>]: Id of the agent to be modified [AppGuid <String>]: GUID of the Application to get details [AppId <Int64?>]: Commvault exchange app id [ApplicationGroupId <Int64?>]: applicationGroupId is the ID of the Kubernetes application group [ArrayId <Int64?>]: [AssetId <String>]: FQDN of the asset [BackupDestinationId <Int64?>]: Id of the backupDestination to be modified [BackupDestionationId <Int64?>]: [BackupLocationId <Int64?>]: Id of the backup location whose details have to be fetched [BlackoutWindowId <Int64?>]: Id of the Blackout Window whose details have to be fetched [BucketId <Int64?>]: Id of Bucket [ClientId <Int64?>]: [CloneId <Int64?>]: ID of the cloned bucket [CloudStorageId <Int64?>]: Id of cloud Storage [ClusterId <Int64?>]: Id of the cluster whose modifier has to be listed. [CompanyId <Int64?>]: Id of the Company whose details have to be fetched [CopyId <Int64?>]: [CredentialId <String>]: [CredentialName <String>]: [DomainId <Int64?>]: ID of the AD/LDAP domain [DrOperation <String>]: Name of DR operation. Case insensitive [DriveId <Int64?>]: Id of the Drive of which the drive details has to be displayed [EntityId <Int64?>]: Recovery entity Id [EntityType <String>]: Type of the entity [FailoverGroupId <Int64?>]: Id of the failover group [GlobalSearchEntity <String>]: name of global search entity [HfsShareId <Int64?>]: Id of the HFS Share to fetch its status [HyperScaleStorageId <Int64?>]: Id of hyperscale storage [HypervisorId <Int64?>]: Id of the HYpervisor to get [Id <Int64?>]: [IndexServerClientId <Int64?>]: Pseudo client id of the index server [InstanceId <Int64?>]: Id of the instance to modify [InventoryId <Int64?>]: Inventory id [JobId <Int64?>]: [KmsId <Int64?>]: Id of Key Management Server [LibraryId <Int64?>]: Id of the library to view the data [MediaAgentId <Int64?>]: Id of the Media Agent whose details have to be fetched [MetadataCacheId <Int64?>]: Id of metadata cache [ModifierName <String>]: Name of the modifier to be read. [Name <String>]: [NameSpace <String>]: Name of the namespace to browse for content [NodeId <Int64?>]: Id of node [PairId <Int64?>]: [PlanId <Int64?>]: Id of the object store plan to fetch details [RecoveryGroupId <Int64?>]: Recovery group Id [RecoveryTargetId <Int64?>]: id of recovery target [RegionId <Int64?>]: Region id to be deleted. [RegionList <String>]: List of region names/ids to be deleted. If region ids are passed, set isRegionIdList=true [ReplicationGroupId <Int64?>]: [RequestId <Int64?>]: Unique identifier for the request [RoleId <Int64?>]: Role Id [RpsId <String>]: [RuleId <Int64?>]: Id of the rule to update in Plan [ScheduleId <Int64?>]: ID of the DR operation schedule [SchedulePolicyId <Int64?>]: [ServerGroupId <Int64?>]: Id of the serverGroupId whose details have to be fetched [ServerId <Int64?>]: Id of the server to modify [StoragePoolId <Int64?>]: Id of the storage pool whose associated copies have to be fetched [SubclientId <Int64?>]: Id of the subclient to modify [TagId <Int64?>]: Id of the tag to delete [TagValue <String>]: tag value to delete [TopologyId <String>]: [UserGroupId <Int64?>]: Id of the user-group whose details have to be fetched [UserId <Int64?>]: Id of the User whose details have to be fetched [VMGroupId <Int64?>]: Id of the VMgroup to update [VMGuid <String>]: [VMUuid <String>]: The vmUUID can be obtained from GET /virtualMachines UUID property [VendorId <Int64?>]: .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/invoke-cvmodifyreplicationgroup #> function Invoke-CVModifyReplicationGroup { [OutputType([Commvault.Powershell.Models.IGenericResp])] [CmdletBinding(DefaultParameterSetName='ModifyExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Modify', Mandatory)] [Parameter(ParameterSetName='ModifyExpanded', Mandatory)] [Commvault.Powershell.Category('Path')] [System.Int64] # . ${ReplicationGroupId}, [Parameter(ParameterSetName='ModifyViaIdentity', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='ModifyViaIdentityExpanded', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Path')] [Commvault.Powershell.Models.ICommvaultPowerShellIdentity] # Identity Parameter # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter(ParameterSetName='Modify', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='ModifyViaIdentity', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IUpdateReplicationGroup] # UpdateReplicationGroupReq # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Set to true to continue to the next priority machines on failure. ${AdvancedOptionContinueOnFailure}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # The delay between machines in different priorities. # Mention in minutes ${AdvancedOptionDelayBetweenPriorityMachines}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IReplicationGroupScript] # Pre/post failover and failback scripts at group level # To construct, see NOTES section for ADVANCEDOPTIONSCRIPT properties and create a hash table. ${AdvancedOptionScript}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Used to disable a replication group ${Disable}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Used to enable a replication group ${Enable}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Used to change the name of a replication group ${NewName}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter()] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds ${PassThru}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ Modify = 'CommvaultPowershell.private\Invoke-CVModifyReplicationGroup_Modify'; ModifyExpanded = 'CommvaultPowershell.private\Invoke-CVModifyReplicationGroup_ModifyExpanded'; ModifyViaIdentity = 'CommvaultPowershell.private\Invoke-CVModifyReplicationGroup_ModifyViaIdentity'; ModifyViaIdentityExpanded = 'CommvaultPowershell.private\Invoke-CVModifyReplicationGroup_ModifyViaIdentityExpanded'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |