New-FilesChildSiteManagementPolicy

Create Child Site Management Policy.

Syntax

New-FilesChildSiteManagementPolicy [-Value <System.Collections.IDictionary>] [-SkipChildSiteIds <System.Int64[]>] [-ChildSiteIds <System.Int64[]>] [-DefaultPolicy <System.Boolean>] -PolicyType <System.String> [-Name <System.String>] [-Description <System.String>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Create Child Site Management Policy.

The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it. It asks for confirmation by default; use -Confirm:$false in scripts that have already decided.

Examples

Example 1: Create Child Site Management Policy

New-FilesChildSiteManagementPolicy -PolicyType 'settings' -Value @{ color2_left = '#000000' } -SkipChildSiteIds 1, 2

Writes the child site management policy returned.

Example 2: Preview the change

New-FilesChildSiteManagementPolicy -PolicyType 'settings' -Value @{ color2_left = '#000000' } -SkipChildSiteIds 1, 2 -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Value

Policy configuration data. Attributes differ by policy type. For more information, refer to the Value Hash section of the developer documentation. Give a hashtable or PSCustomObject; keys keep their case and values their types.

  • Type: System.Collections.IDictionary
  • Parameter sets: (All)

-SkipChildSiteIds

IDs of child sites excluded from this default policy.

  • Type: System.Int64[]
  • Parameter sets: (All)

-ChildSiteIds

IDs of child sites explicitly assigned to this non-default policy.

  • Type: System.Int64[]
  • Parameter sets: (All)

-DefaultPolicy

Whether this policy applies to child sites not explicitly assigned to another policy.

  • Type: System.Boolean
  • Parameter sets: (All)

-PolicyType

Type of policy. Valid values: settings.

  • Type: System.String
  • Parameter sets: (All) (required)

-Name

Name for this policy.

  • Type: System.String
  • Parameter sets: (All)

-Description

Description for this policy.

  • Type: System.String
  • Parameter sets: (All)

-Connection

The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.

  • Type: FilesCom.PowerShell.FilesConnection
  • Parameter sets: (All)

-WorkspaceScope

Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.

  • Type: System.Int64
  • Parameter sets: (All)

-NoWorkspaceScope

Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.

  • Type: System.Management.Automation.SwitchParameter
  • Parameter sets: (All)

-Confirm

Prompts you for confirmation before running the cmdlet.

  • Type: System.Management.Automation.SwitchParameter
  • Confirm impact: High. At the default $ConfirmPreference of High, the command asks before each change; -Confirm:$false runs it without asking.

-WhatIf

Shows what the cmdlet would change without sending anything to Files.com.

  • Type: System.Management.Automation.SwitchParameter

Common Parameters

This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.

Inputs

None. The command takes no pipeline input.

Outputs

  • FilesCom.PowerShell.Models.ChildSiteManagementPolicy: the child site management policy as Files.com returned it.

Notes

Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.