Set-SCLibraryServer

Set-SCLibraryServer

Sets the properties of a VMM library server.

Syntax

Parameter Set: Default
Set-SCLibraryServer [-LibraryServer] <LibraryServer> [-ClearVMHostGroup] [-Description <String> ] [-EnableUnencryptedFileTransfer <Boolean> ] [-JobGroup <Guid> ] [-JobVariable <String> ] [-LibraryServerManagementCredential <RunAsAccount> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-VMHostGroup <HostGroup> ] [ <CommonParameters>]

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

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

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

Detailed Description

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

Parameters

-AddVMNetwork<VMNetwork[]>

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

-ClearVMHostGroup

Resets the host group association for the library server.

-Description<String>

States a description for the specified object.

-EnableUnencryptedFileTransfer<Boolean>

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.

-JobGroup<Guid>

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.

-JobVariable<String>

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

-LibraryServer<LibraryServer>

Specifies a VMM library server object.

-LibraryServerManagementCredential<RunAsAccount>

Specifies a Run As account for the VMM library.

-PROTipID<Guid>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

-RemoveVMNetwork<VMNetwork[]>

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

-RunAsynchronously

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

-VMHostGroup<HostGroup>

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

-VMNetworks<VMNetwork[]>

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• LibraryServer

Notes

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

Examples

1: Change the description of a library server.

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.”

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

2: Update the description for a library server.

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.

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."

3: Add a VM network to a library server.

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 which adds VMNetwork01 to the library server.

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

Related topics

Add-SCLibraryServer

Get-SCLibraryServer

Remove-SCLibraryServer