exports/Invoke-CVModifyFailoverGroup.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 API to modify failover group .Description API to modify failover 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.IModifyFailoverGroupRequest .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. ARRAYREPLICATIONPAIRS <IFailoverGroupArrayReplicationPair[]>: List of all array replication pairs for failover group [DestinationName <String>]: The name of the destination machine [Guid <String>]: The GUID of the source of array replication pair [Hostname <String>]: The hostname specified for the destination machine [IPSettings <IIPAddressSettingVmwareCreate[]>]: The settings for IP address mapping [DestinationAlternateDns <String>]: The alternate DNS server for the destination VM. Provide only if DHCP is not enabled [DestinationAlternateWins <String>]: The alternate WINS server for the destination VM. Provide only if DHCP is not enabled [DestinationIP <String>]: The full IP address or an IP address pattern for the destination VM. Provide only if DHCP is not enabled. [DestinationPreferredDns <String>]: The preferred DNS server for the destination VM. Provide only if DHCP is not enabled [DestinationPreferredWins <String>]: The preferred WINS server for the destination VM. Provide only if DHCP is not enabled [DestinationSubnetMask <String>]: The subnet mask for the destination VM. Provide only if DHCP is not enabled. [DestinationdefaultGateway <String>]: The default gateway for the destination VM. Provide only if DHCP is not enabled. [Hostname <String>]: The host name to be applied for the destination VM. [SourceDefaultGateway <String>]: The default gateway of the source VM. [SourceIP <String>]: The full IP address or an IP address pattern of the source VM. [SourceSubnetMask <String>]: The subnet mask of the source VM. [UseDhcp <Boolean?>]: Automatically assigns available IP addresses to be used with the specified destination network. [Id <Int64?>]: The ID of the array replication pair [Priority <Int64?>]: The priority of the array replication pair for DR operation in failover group. The lower values signify higher priority [SourceName <String>]: The name of the source machine BODY <IModifyFailoverGroupRequest>: Modify failover group request [ArrayReplicationPairs <IFailoverGroupArrayReplicationPair[]>]: List of all array replication pairs for failover group [DestinationName <String>]: The name of the destination machine [Guid <String>]: The GUID of the source of array replication pair [Hostname <String>]: The hostname specified for the destination machine [IPSettings <IIPAddressSettingVmwareCreate[]>]: The settings for IP address mapping [DestinationAlternateDns <String>]: The alternate DNS server for the destination VM. Provide only if DHCP is not enabled [DestinationAlternateWins <String>]: The alternate WINS server for the destination VM. Provide only if DHCP is not enabled [DestinationIP <String>]: The full IP address or an IP address pattern for the destination VM. Provide only if DHCP is not enabled. [DestinationPreferredDns <String>]: The preferred DNS server for the destination VM. Provide only if DHCP is not enabled [DestinationPreferredWins <String>]: The preferred WINS server for the destination VM. Provide only if DHCP is not enabled [DestinationSubnetMask <String>]: The subnet mask for the destination VM. Provide only if DHCP is not enabled. [DestinationdefaultGateway <String>]: The default gateway for the destination VM. Provide only if DHCP is not enabled. [Hostname <String>]: The host name to be applied for the destination VM. [SourceDefaultGateway <String>]: The default gateway of the source VM. [SourceIP <String>]: The full IP address or an IP address pattern of the source VM. [SourceSubnetMask <String>]: The subnet mask of the source VM. [UseDhcp <Boolean?>]: Automatically assigns available IP addresses to be used with the specified destination network. [Id <Int64?>]: The ID of the array replication pair [Priority <Int64?>]: The priority of the array replication pair for DR operation in failover group. The lower values signify higher priority [SourceName <String>]: The name of the source machine [ContinueDrOnFailure <Boolean?>]: Modify whether to continue to next priority on DR job failure [IsApprovalRequired <Boolean?>]: Modify whether user approval is required for DR operation or not [Name <String>]: New name for failover group [PriorityIntervalInMinutes <Int64?>]: Modify the time interval between DR operations of different priorities in minutes [RecoveryTargetId <Int64?>]: [RecoveryTargetName <String>]: [ReplicationPairs <IFailoverGroupReplicationPair[]>]: List of all replication pairs that are part of the failover group [CopyPrecedence <Int64?>]: The copy precedence of replication pair [DestinationName <String>]: The name of the destination machine [Guid <String>]: The GUID of the source of replication pair [Id <Int64?>]: The ID of the replication pair [PostFailoverScriptGuestCredentialsCredentialsName <String>]: username to access the network path [PostFailoverScriptGuestCredentialsCredentialsPassword <String>]: password to access the network path [PostFailoverScriptGuestCredentialsSavedCredentialsId <Int64?>]: [PostFailoverScriptGuestCredentialsSavedCredentialsName <String>]: [PostFailoverScriptPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PostFailoverScriptReset <Boolean?>]: On set to true, resets the script to empty [PostFailoverScriptScriptCredentialsCredentialsName <String>]: username to access the network path [PostFailoverScriptScriptCredentialsCredentialsPassword <String>]: password to access the network path [PostFailoverScriptScriptCredentialsSavedCredentialsId <Int64?>]: [PostFailoverScriptScriptCredentialsSavedCredentialsName <String>]: [PostFailoverScriptType <String>]: The type of path being used for DR operation script [PreFailoverScriptGuestCredentialsCredentialsName <String>]: username to access the network path [PreFailoverScriptGuestCredentialsCredentialsPassword <String>]: password to access the network path [PreFailoverScriptGuestCredentialsSavedCredentialsId <Int64?>]: [PreFailoverScriptGuestCredentialsSavedCredentialsName <String>]: [PreFailoverScriptPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PreFailoverScriptReset <Boolean?>]: On set to true, resets the script to empty [PreFailoverScriptScriptCredentialsCredentialsName <String>]: username to access the network path [PreFailoverScriptScriptCredentialsCredentialsPassword <String>]: password to access the network path [PreFailoverScriptScriptCredentialsSavedCredentialsId <Int64?>]: [PreFailoverScriptScriptCredentialsSavedCredentialsName <String>]: [PreFailoverScriptType <String>]: The type of path being used for DR operation script [Priority <Int64?>]: The priority of the replication pair for DR operation in failover group. The lower values signify higher priority [SourceName <String>]: The name of the source machine [UsersToNotify <IIdNameDisplayNameCompany[]>]: Users to notify/for approval of DR operations [CompanyId <Int64?>]: [CompanyName <String>]: [DisplayName <String>]: [Id <Int64?>]: [Name <String>]: 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?>]: [CloudStorageId <Int64?>]: Id of cloud Storage [ClusterId <Int64?>]: [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?>]: Unique id for the entity [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 [Name <String>]: [NameSpace <String>]: Name of the namespace to browse for content [NodeId <Int64?>]: Id of node [PairId <Int64?>]: [PlanId <Int64?>]: Id of the plan to fetch details [RecoveryTargetId <Int64?>]: id of recovery target [RegionId <Int64?>]: [RegionList <String>]: List of region names/ids to be deleted. If region ids are passed, set isRegionIdList=true [ReplicationGroupId <String>]: [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>]: GUID of the Provisioned VM [VMUuid <String>]: The vmUUID can be obtained from GET /virtualMachines UUID property [VendorId <Int64?>]: REPLICATIONPAIRS <IFailoverGroupReplicationPair[]>: List of all replication pairs that are part of the failover group [CopyPrecedence <Int64?>]: The copy precedence of replication pair [DestinationName <String>]: The name of the destination machine [Guid <String>]: The GUID of the source of replication pair [Id <Int64?>]: The ID of the replication pair [PostFailoverScriptGuestCredentialsCredentialsName <String>]: username to access the network path [PostFailoverScriptGuestCredentialsCredentialsPassword <String>]: password to access the network path [PostFailoverScriptGuestCredentialsSavedCredentialsId <Int64?>]: [PostFailoverScriptGuestCredentialsSavedCredentialsName <String>]: [PostFailoverScriptPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PostFailoverScriptReset <Boolean?>]: On set to true, resets the script to empty [PostFailoverScriptScriptCredentialsCredentialsName <String>]: username to access the network path [PostFailoverScriptScriptCredentialsCredentialsPassword <String>]: password to access the network path [PostFailoverScriptScriptCredentialsSavedCredentialsId <Int64?>]: [PostFailoverScriptScriptCredentialsSavedCredentialsName <String>]: [PostFailoverScriptType <String>]: The type of path being used for DR operation script [PreFailoverScriptGuestCredentialsCredentialsName <String>]: username to access the network path [PreFailoverScriptGuestCredentialsCredentialsPassword <String>]: password to access the network path [PreFailoverScriptGuestCredentialsSavedCredentialsId <Int64?>]: [PreFailoverScriptGuestCredentialsSavedCredentialsName <String>]: [PreFailoverScriptPath <String>]: The path of the script to be executed. Can be local path on VM or UNC path accessible by access node [PreFailoverScriptReset <Boolean?>]: On set to true, resets the script to empty [PreFailoverScriptScriptCredentialsCredentialsName <String>]: username to access the network path [PreFailoverScriptScriptCredentialsCredentialsPassword <String>]: password to access the network path [PreFailoverScriptScriptCredentialsSavedCredentialsId <Int64?>]: [PreFailoverScriptScriptCredentialsSavedCredentialsName <String>]: [PreFailoverScriptType <String>]: The type of path being used for DR operation script [Priority <Int64?>]: The priority of the replication pair for DR operation in failover group. The lower values signify higher priority [SourceName <String>]: The name of the source machine USERSTONOTIFY <IIdNameDisplayNameCompany[]>: Users to notify/for approval of DR operations [CompanyId <Int64?>]: [CompanyName <String>]: [DisplayName <String>]: [Id <Int64?>]: [Name <String>]: .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/invoke-cvmodifyfailovergroup #> function Invoke-CVModifyFailoverGroup { [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] # Id of the failover group ${FailoverGroupId}, [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.IModifyFailoverGroupRequest] # Modify failover group request # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IFailoverGroupArrayReplicationPair[]] # List of all array replication pairs for failover group # To construct, see NOTES section for ARRAYREPLICATIONPAIRS properties and create a hash table. ${ArrayReplicationPairs}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Modify whether to continue to next priority on DR job failure ${ContinueDrOnFailure}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Modify whether user approval is required for DR operation or not ${IsApprovalRequired}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # New name for failover group ${Name}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Modify the time interval between DR operations of different priorities in minutes ${PriorityIntervalInMinutes}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${RecoveryTargetId}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${RecoveryTargetName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IFailoverGroupReplicationPair[]] # List of all replication pairs that are part of the failover group # To construct, see NOTES section for REPLICATIONPAIRS properties and create a hash table. ${ReplicationPairs}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdNameDisplayNameCompany[]] # Users to notify/for approval of DR operations # To construct, see NOTES section for USERSTONOTIFY properties and create a hash table. ${UsersToNotify}, [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(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-CVModifyFailoverGroup_Modify'; ModifyExpanded = 'CommvaultPowershell.private\Invoke-CVModifyFailoverGroup_ModifyExpanded'; ModifyViaIdentity = 'CommvaultPowershell.private\Invoke-CVModifyFailoverGroup_ModifyViaIdentity'; ModifyViaIdentityExpanded = 'CommvaultPowershell.private\Invoke-CVModifyFailoverGroup_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 } } } |