Set-ContentLibrary

This cmdlet modifies content library's properties.

Syntax

-Evict
-SubscribedContentLibrary  <SubscribedContentLibrary[]>
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Evict
SwitchParameter named Removes cached content library's items content of a subscribed content library whose content is downloaded on demand.
required
SubscribedContentLibrary
SubscribedContentLibrary[] named
  • wildcards
  • pipeline
  • Specifies a subscribed content library which properties you want to alter.
    optional
    Server
    VIServer[] named Specifies the vCenter Server systems on which you want to run the cmdlet. If no given is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.

    -LocalContentLibrary  <LocalContentLibrary[]>
    [-CurrentPassword  <String>]
    [-Description  <String>]
    [-DisableAuthentication]
    [-Name  <String>]
    [-Password  <String>]
    [-PersistJson]
    [-Published]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    LocalContentLibrary
    LocalContentLibrary[] named
  • pipeline
  • A local content library whose properties you want to alter.
    optional
    CurrentPassword
    String named Indicates if you want to update a password protected content library. Currently set password is supplied to complete the operation.
    optional
    Description
    String named Specifies a human-readable description for the content library that you want to create.
    optional
    DisableAuthentication
    SwitchParameter named If specified, disables authentication of the content library.
    optional
    Name
    String named Specifies a new name for the content library.
    optional
    Password
    String named Specifies the password that you want to set or update to the target content library.
    optional
    PersistJson
    SwitchParameter named Specifies whether library and library item metadata are persisted in the storage location as JSON files. This flag only applies if you want to publish the local library.
    optional
    Published
    SwitchParameter named Specifies whether you want to publish the local library.
    optional
    Server
    VIServer[] named Specifies the vCenter Server systems on which you want to run the cmdlet. If no given is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.

    -SubscribedContentLibrary  <SubscribedContentLibrary[]>
    [-AutomaticSync]
    [-Description  <String>]
    [-DisableAuthentication]
    [-DownloadContentOnDemand]
    [-Name  <String>]
    [-Password  <String>]
    [-Server  <VIServer[]>]
    [-SslThumbprint  <String>]
    [-SubscriptionUrl  <String>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    SubscribedContentLibrary
    SubscribedContentLibrary[] named
  • wildcards
  • pipeline
  • Specifies a subscribed content library which properties you want to alter.
    optional
    AutomaticSync
    SwitchParameter named If specified, synchronization of content library items happens automatically. If not, synchronization happens by using the Set-ContentLibrary cmdlet with the Sync parameter.
    optional
    Description
    String named Specifies a human-readable description for the content library that you want to create.
    optional
    DisableAuthentication
    SwitchParameter named If specified, disables authentication of the content library.
    optional
    DownloadContentOnDemand
    SwitchParameter named Indicates whether a library item's content is synchronized only on demand.
    optional
    Name
    String named Specifies a new name for the content library.
    optional
    Password
    String named Specifies the password that you want to set or update to the target content library.
    optional
    Server
    VIServer[] named Specifies the vCenter Server systems on which you want to run the cmdlet. If no given is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
    optional
    SslThumbprint
    String named Specifies an optional SHA-1 hash of the SSL certificate for the remote endpoint.
    optional
    SubscriptionUrl
    String named Specifies the URL of the endpoint where the metadata for the remotely published library is served.

    -SubscribedContentLibrary  <SubscribedContentLibrary[]>
    -Sync
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    SubscribedContentLibrary
    SubscribedContentLibrary[] named
  • wildcards
  • pipeline
  • Specifies a subscribed content library which properties you want to alter.
    required
    Sync
    SwitchParameter named If specified, manually synchronizes the subscribed content library.
    optional
    Server
    VIServer[] named Specifies the vCenter Server systems on which you want to run the cmdlet. If no given is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.

    Output

    VMware.VimAutomation.ViCore.Types.V1.ContentLibrary.ContentLibrary

    Examples


    Example 1

    PS C:\> $contentLibrary = Get-ContentLibrary -Name 'Content Library' -Local
    PS C:\> Set-ContentLibrary -LocalContentLibrary $contentLibrary -Name 'Local Content Library' -Description 'This is local content library.'

    Modifies a local content library named 'Content Library' by changing its name to 'Local Content Library' and its description to 'This is local content library.'.

    Example 2

    PS C:\> $subscribedContentLibrary = Get-ContentLibrary -Name 'Content Library' -Subscribed
    PS C:\> Set-ContentLibrary -SubscribedContentLibrary $subscribedContentLibrary -Sync

    Manually synchronizes a subscribed content library named 'Content Library'.

    Example 3

    PS C:\> $subscribedContentLibrary = Get-ContentLibrary -Name 'Content Library' -Subscribed
    PS C:\> Set-ContentLibrary -SubscribedContentLibrary $subscribedContentLibrary -Evict

    Removes cached content library items' content of subscribed content library that has -DownloadContentOnDemand set.

    Related Commands

    Feedback

    Was this page helpful?