Share via

Set-SCLibraryServer

  • Reference
Module:
VirtualMachineManager

Sets the properties of a VMM library server.

Syntax

Set-SCLibraryServer
   [-LibraryServerManagementCredential <RunAsAccount>]
   [-LibraryServer] <LibraryServer>
   [-Description <String>]
   [-VMHostGroup <HostGroup>]
   [-ClearVMHostGroup]
   [-JobGroup <Guid>]
   [-EnableUnencryptedFileTransfer <Boolean>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCLibraryServer
   [-LibraryServerManagementCredential <RunAsAccount>]
   [-LibraryServer] <LibraryServer>
   [-Description <String>]
   [-VMHostGroup <HostGroup>]
   [-ClearVMHostGroup]
   [-JobGroup <Guid>]
   -VMNetworks <VMNetwork[]>
   [-EnableUnencryptedFileTransfer <Boolean>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCLibraryServer
   [-LibraryServerManagementCredential <RunAsAccount>]
   [-LibraryServer] <LibraryServer>
   [-Description <String>]
   [-VMHostGroup <HostGroup>]
   [-ClearVMHostGroup]
   [-JobGroup <Guid>]
   -AddVMNetwork <VMNetwork[]>
   [-EnableUnencryptedFileTransfer <Boolean>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Set-SCLibraryServer
   [-LibraryServerManagementCredential <RunAsAccount>]
   [-LibraryServer] <LibraryServer>
   [-Description <String>]
   [-VMHostGroup <HostGroup>]
   [-ClearVMHostGroup]
   [-JobGroup <Guid>]
   -RemoveVMNetwork <VMNetwork[]>
   [-EnableUnencryptedFileTransfer <Boolean>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The Set-SCLibraryServer cmdlet sets the properties of a Virtual Machine Manager (VMM) library server. You can also use this cmdlet as part of a job group, when used with the Add-SCLibraryShare cmdlet, to add a set of library shares.

Examples

Example 1: Change the description of a library server

PS C:\> $LibServer = Get-SCLibraryServer -VMMServer "VMMServer01.Contoso.com" -ComputerName "LibraryServer01.Contoso.com"
PS C:\> Set-SCLibraryServer -LibraryServer $LibServer -Description "Library server for Production"

The first command gets the library server object named LibraryServer01 on VMMServer01 and stores it in the $LibServer variable.

The second command changes the description for FileServer01 to "Library server for Production."

Example 2: Update the description for a library server

PS C:\> $LibServer = Get-SCLibraryServer -VMMServer "VMMServer01.Contoso.com" -ComputerName "LibraryServer01.Contoso.com"
PS C:\> Set-SCLibraryServer -LibraryServer $LibServer -Description "The library server is used by the Seattle office."

The first command gets the library server object named LibraryServer01 on VMMServer01 and stores it in the $LibServer variable.

The second command updates the description for the library server object stored in the $LibServer variable.

Example 3: Add a VM network to a library server

PS C:\> $VMNetwork = Get-SCVMNetwork -Name "VMNetwork01"
PS C:\> Get-SCLibraryServer -ComputerName "LibraryServer01.Contoso.com" | Set-SCLibraryServer -AddVMNetwork $VMNetwork

The first command gets the VM network object named VMNetwork01 and stores the object in the $VMNetwork variable.

The second command gets the library server object named LibraryServer01 and uses the pipeline operator to pass the object to the Set-SCLibraryServer cmdlet, which adds VMNetwork01 to the library server.

Parameters

-AddVMNetwork

Specifies that one or more VM networks has network connectivity to the specified library server when used in conjunction with Set-SCLibraryServer.

Type:VMNetwork[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ClearVMHostGroup

Resets the host group association for the library server.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the library server.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableUnencryptedFileTransfer

Indicates, when set to True, that network file transfers do not require encryption. Allowing unencrypted network file transfers can improve performance if neither the source host nor the destination host requires encryption.

Use this parameter to:

  • Enable unencrypted file transfers into, or out of, the library.
  • Enable unencrypted file transfers into, out of, or within a host group.
Type:Boolean
Aliases:AllowUnencryptedTransfers
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobGroup

Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LibraryServer

Specifies a VMM library server object.

Type:LibraryServer
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LibraryServerManagementCredential

Specifies a Run As account for the VMM library.

Type:RunAsAccount
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveVMNetwork

Removes network connectivity for one or more VM networks from the specified library server when used in conjunction with Set-SCVMLibraryServer.

Type:VMNetwork[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMHostGroup

Specifies a virtual machine host group object or an array of host group objects.

Type:HostGroup
Aliases:LibraryGroup
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMNetworks

Specifies that one or more VM networks have network connectivity to the specified library server when used in conjunction with Set-SCVMLibraryServer.

Type:VMNetwork[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

LibraryServer

This cmdlet returns a LibraryServer object.

Notes

  • Requires a VMM library server object, which can be retrieved by using the Get-SCLibraryServer cmdlet.