exports/Invoke-CVSnapMount.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 Mounting a snapshot from the Storage Array .Description Mounting a snapshot from the Storage Array .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.IMountReq .Outputs Commvault.Powershell.Models.ISnapReconResp .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. APPID <IVsaApplicationDetails[]>: . [ApptypeId <Int64?>]: apptype id or agent type [ClientId <Int64?>]: hypervisor Id of hypervisor where user is mounting snapshot [InstanceId <Int64?>]: instance id of the instance to which subclient is associated [SubclientId <Int64?>]: subclient id associated to snapshot BODY <IMountReq>: Request template for Mounting Snapshots. scsiServer refers to the iSCSI server which the user can choose while mounting. [AppId <IVsaApplicationDetails[]>]: [ApptypeId <Int64?>]: apptype id or agent type [ClientId <Int64?>]: hypervisor Id of hypervisor where user is mounting snapshot [InstanceId <Int64?>]: instance id of the instance to which subclient is associated [SubclientId <Int64?>]: subclient id associated to snapshot [DestinationClientId <Int64?>]: Id of the MA where the Snap is mounted [DestinationClientPath <String>]: Path where the snap is mounted [ProtectSnap <Int64?>]: Enable or disable VSS protection on Snaps while mounting [ScsiServerId <Int64?>]: [ScsiServerName <String>]: [Server <IVsaServerDetails[]>]: [ServerName <String>]: server name [ServerType <Int64?>]: type of server [UserName <String>]: [Volumes <IVolumeSnap[]>]: Volumes of the snap you want to mount [Flags <Int64?>]: Volume flags to be set for snap Operations. [SmVolumeId <Int64?>]: smVolumeId of the snaps you want to mount/unmount/delete 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?>]: SERVER <IVsaServerDetails[]>: . [ServerName <String>]: server name [ServerType <Int64?>]: type of server VOLUMES <IVolumeSnap[]>: Volumes of the snap you want to mount [Flags <Int64?>]: Volume flags to be set for snap Operations. [SmVolumeId <Int64?>]: smVolumeId of the snaps you want to mount/unmount/delete .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/invoke-cvsnapmount #> function Invoke-CVSnapMount { [OutputType([Commvault.Powershell.Models.ISnapReconResp])] [CmdletBinding(DefaultParameterSetName='SnapExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Snap', Mandatory)] [Parameter(ParameterSetName='SnapExpanded', Mandatory)] [Commvault.Powershell.Category('Path')] [System.Int64] # . ${ArrayId}, [Parameter(ParameterSetName='SnapViaIdentity', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='SnapViaIdentityExpanded', 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='Snap', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='SnapViaIdentity', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IMountReq] # Request template for Mounting Snapshots. # scsiServer refers to the iSCSI server which the user can choose while mounting. # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='SnapExpanded')] [Parameter(ParameterSetName='SnapViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IVsaApplicationDetails[]] # . # To construct, see NOTES section for APPID properties and create a hash table. ${AppId}, [Parameter(ParameterSetName='SnapExpanded')] [Parameter(ParameterSetName='SnapViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Id of the MA where the Snap is mounted ${DestinationClientId}, [Parameter(ParameterSetName='SnapExpanded')] [Parameter(ParameterSetName='SnapViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Path where the snap is mounted ${DestinationClientPath}, [Parameter(ParameterSetName='SnapExpanded')] [Parameter(ParameterSetName='SnapViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Enable or disable VSS protection on Snaps while mounting ${ProtectSnap}, [Parameter(ParameterSetName='SnapExpanded')] [Parameter(ParameterSetName='SnapViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${ScsiServerId}, [Parameter(ParameterSetName='SnapExpanded')] [Parameter(ParameterSetName='SnapViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${ScsiServerName}, [Parameter(ParameterSetName='SnapExpanded')] [Parameter(ParameterSetName='SnapViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IVsaServerDetails[]] # . # To construct, see NOTES section for SERVER properties and create a hash table. ${Server}, [Parameter(ParameterSetName='SnapExpanded')] [Parameter(ParameterSetName='SnapViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${UserName}, [Parameter(ParameterSetName='SnapExpanded')] [Parameter(ParameterSetName='SnapViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IVolumeSnap[]] # Volumes of the snap you want to mount # To construct, see NOTES section for VOLUMES properties and create a hash table. ${Volumes}, [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 = @{ Snap = 'CommvaultPowershell.private\Invoke-CVSnapMount_Snap'; SnapExpanded = 'CommvaultPowershell.private\Invoke-CVSnapMount_SnapExpanded'; SnapViaIdentity = 'CommvaultPowershell.private\Invoke-CVSnapMount_SnapViaIdentity'; SnapViaIdentityExpanded = 'CommvaultPowershell.private\Invoke-CVSnapMount_SnapViaIdentityExpanded'; } $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 } } } |