Export (0) Print
Expand All
Expand Minimize

Set-SCLibraryServer

Updated: April 29, 2014

Applies To: System Center 2012 R2 Virtual Machine Manager

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

Parameters

-AddVMNetwork<VMNetwork[]>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClearVMHostGroup

Indicates that this cmdlet resets the host group association for the library server.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

States a description for the specified object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableUnencryptedFileTransfer<Boolean>

Indicates whether 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobVariable<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LibraryServer<LibraryServer>

Specifies a VMM library server object.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-LibraryServerManagementCredential<RunAsAccount>

Specifies a Run As account for the VMM library.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemoveVMNetwork<VMNetwork[]>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMHostGroup<HostGroup>

Specifies a virtual machine host group object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMNetworks<VMNetwork[]>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

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

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

Examples

Example 1: Change the description of a library server

The first command gets the library server object named LibraryServer01 on VMMServer01, and then 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"

Example 2: Update the description for a library server

The first command gets the library server object named LibraryServer01 on VMMServer01, and then 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."

Example 3: Add a virtual machine network to a library server

The first command gets the virtual machine network object named VMNetwork01, and then 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 Set-SCLibraryServer. That cmdlet 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

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft