exports/Get-CVNode.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 deploy Access Node .Description API to deploy Access Node .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Commvault.Powershell.Models.IAccessNodeDeployment .Outputs Commvault.Powershell.Models.ICreateTaskRespforBackup .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. BODY <IAccessNodeDeployment>: AccessNodeDeployment NetworkName <String>: Destination network name UserCredentialsPassword <String>: UserCredentialsUserName <String>: VCenter <String>: vCenter server instance VMLocationDataCenterName <String>: VMLocationDatastore <String>: If cluster is selected for storage then moref of datastore cluster else dataStoreName VMLocationHost <String>: If ESX-Host for resource the host moref or If ESX-Cluster then cluster moref and if resource pool is used for resource then first go for host moref then cluster moref VMName <String>: [AutomaticOSUpdates <Boolean?>]: [ClientGroup <String>]: [CommCellHostName <String>]: CommServer host name [CommCellName <String>]: CommServer name [DeploymentType <Int64?>]: 0: Access node deployment, 1: File recovery enabler for linux deployment [HardDiskType <Int64?>]: 1: Thin Provision, 2: Thick provision lazy zeroed, 3: Thick provision eager zeroed [HostName <String>]: Host name for vm, if not provided it will be same as vmName [Name <String>]: Client name for vm, if not provided it will be same as vmName [NetworkDnsSearch <String>]: [NetworkGateway <String>]: [NetworkNameservers <String[]>]: [NetworkNetmask <String>]: [NetworkStaticIP <String>]: [NetworkUseDhcp <String>]: If useDHCP is False then make sure to provide staticIP, netmask, gateway [NotifyUserOnJobCompletion <Boolean?>]: [OS <String>]: [Timezone <String>]: Linux OS qualified timezones [VMLocationCluster <String>]: ESX-Cluster moref if cluster is selected for resource [VMLocationInventoryPath <String>]: Folder path where you can locate vm, empty if Datacenter is selected for location. Default is set to Datacenter [VMLocationResourcePool <String>]: Resource Pool moref if resource pool is selected for resource .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/get-cvnode #> function Get-CVNode { [OutputType([Commvault.Powershell.Models.ICreateTaskRespforBackup])] [CmdletBinding(DefaultParameterSetName='AccessExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Access', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IAccessNodeDeployment] # AccessNodeDeployment # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='AccessExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # Destination network name ${NetworkName}, [Parameter(ParameterSetName='AccessExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # . ${UserCredentialsPassword}, [Parameter(ParameterSetName='AccessExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # . ${UserCredentialsUserName}, [Parameter(ParameterSetName='AccessExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # vCenter server instance ${VCenter}, [Parameter(ParameterSetName='AccessExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # . ${VMLocationDataCenterName}, [Parameter(ParameterSetName='AccessExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # If cluster is selected for storage then moref of datastore cluster else dataStoreName ${VMLocationDatastore}, [Parameter(ParameterSetName='AccessExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # If ESX-Host for resource the host moref or If ESX-Cluster then cluster moref and if resource pool is used for resource then first go for host moref then cluster moref ${VMLocationHost}, [Parameter(ParameterSetName='AccessExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # . ${VMName}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # . ${AutomaticOSUpdates}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${ClientGroup}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # CommServer host name ${CommCellHostName}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # CommServer name ${CommCellName}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # 0: Access node deployment, 1: File recovery enabler for linux deployment ${DeploymentType}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # 1: Thin Provision, 2: Thick provision lazy zeroed, 3: Thick provision eager zeroed ${HardDiskType}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Host name for vm, if not provided it will be same as vmName ${HostName}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Client name for vm, if not provided it will be same as vmName ${Name}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${NetworkDnsSearch}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${NetworkGateway}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # . ${NetworkNameservers}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${NetworkNetmask}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${NetworkStaticIP}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # If useDHCP is False then make sure to provide staticIP, netmask, gateway ${NetworkUseDhcp}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # . ${NotifyUserOnJobCompletion}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${OS}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Linux OS qualified timezones ${Timezone}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # ESX-Cluster moref if cluster is selected for resource ${VMLocationCluster}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Folder path where you can locate vm, empty if Datacenter is selected for location. # Default is set to Datacenter ${VMLocationInventoryPath}, [Parameter(ParameterSetName='AccessExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Resource Pool moref if resource pool is selected for resource ${VMLocationResourcePool}, [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 = @{ Access = 'CommvaultPowershell.private\Get-CVNode_Access'; AccessExpanded = 'CommvaultPowershell.private\Get-CVNode_AccessExpanded'; } $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 } } } |