posh-kentico.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Initialize-CMSApplication --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Initialize-CMSApplication</command:name> <command:verb>Initialize</command:verb> <command:noun>CMSApplication</command:noun> <maml:description> <maml:para>Initializes a connection to the Kentico CMS Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Initialize-CMSApplication cmdlet initializes a connection to the Kentico CMS server.</maml:para> <maml:para></maml:para> <maml:para>If this cmdlet is run without parameters, then it requires administrator permissions to find the Kentico site.</maml:para> <maml:para>It does so by performing the following steps:</maml:para> <maml:para>1. Get a list of all the sites from IIS</maml:para> <maml:para>2. Get a list of all applications from the sites</maml:para> <maml:para>3. Get a list of all the virtual directories from the applications</maml:para> <maml:para>4. Continue processing virtual directory if a web.config file exits</maml:para> <maml:para>5. Parse the document and find an "add" node with name="CMSConnectionString"</maml:para> <maml:para>6. If the connection string is valid, then stop processing</maml:para> </maml:description> <command:syntax> <!-- Parameter set: None --> <command:syntaxItem> <maml:name>Initialize-CMSApplication</maml:name> <!-- Parameter: Cached --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="UseCached"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Use the previous successful site and connection string information found.</maml:para> <maml:para>If none, then this is the same as supplying no parameters.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ConnectionString --> <command:syntaxItem> <maml:name>Initialize-CMSApplication</maml:name> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string for the database connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WebRoot --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="KenticoRoot"> <maml:name>WebRoot</maml:name> <maml:description> <maml:para>The root directory for the Kentico site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ServerAndDatabase --> <command:syntaxItem> <maml:name>Initialize-CMSApplication</maml:name> <!-- Parameter: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="SQLServer"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>The database server to use for generating the connection string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database to use for generating the connection string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WebRoot --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="KenticoRoot"> <maml:name>WebRoot</maml:name> <maml:description> <maml:para>The root directory for the Kentico site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout to use for generating the connection string.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Cached --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="UseCached"> <maml:name>Cached</maml:name> <maml:description> <maml:para>Use the previous successful site and connection string information found.</maml:para> <maml:para>If none, then this is the same as supplying no parameters.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="UseCached"> <maml:name>UseCached</maml:name> <maml:description> <maml:para>Use the previous successful site and connection string information found.</maml:para> <maml:para>If none, then this is the same as supplying no parameters.</maml:para> <maml:para>This is an alias of the Cached parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string for the database connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="SQLServer"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>The database server to use for generating the connection string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="SQLServer"> <maml:name>SQLServer</maml:name> <maml:description> <maml:para>The database server to use for generating the connection string.</maml:para> <maml:para>This is an alias of the DatabaseServer parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database to use for generating the connection string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout to use for generating the connection string.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <!-- Parameter: WebRoot --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="KenticoRoot"> <maml:name>WebRoot</maml:name> <maml:description> <maml:para>The root directory for the Kentico site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="KenticoRoot"> <maml:name>KenticoRoot</maml:name> <maml:description> <maml:para>The root directory for the Kentico site.</maml:para> <maml:para>This is an alias of the WebRoot parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Initialize the Kentico CMS Application by searching for the Kentico site.</maml:para> <maml:para>This option requires administrator rights.</maml:para> </maml:introduction> <dev:code>Initialize-CMSApplication</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Initialize the Kentico CMS Application by using the specified connection string.</maml:para> <maml:para>This option does not require administrator rights.</maml:para> </maml:introduction> <dev:code>Initialize-CMSApplication -DatabaseServer KenticoServer -Database Kentico -WebRoot C:\kentico</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CMSRoleLog --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CMSRoleLog</command:name> <command:verb>Set</command:verb> <command:noun>CMSRoleLog</command:noun> <maml:description> <maml:para>Set a new role to log staging tasks under specific task groups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set a new role to log staging tasks under specific task groups.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Set-CMSRoleLog</maml:name> <!-- Parameter: RoleToSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RoleToSet</maml:name> <maml:description> <maml:para>A reference to the role to set.</maml:para> </maml:description> <command:parameterValue required="true">RoleInfo</command:parameterValue> <dev:type> <maml:name>CMS.Membership.RoleInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TaskGroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TaskGroupName</maml:name> <maml:description> <maml:para>The task group name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the role to set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Set-CMSRoleLog</maml:name> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The role name for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The role site id for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TaskGroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>TaskGroupName</maml:name> <maml:description> <maml:para>The task group name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the role to set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: RoleToSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RoleToSet</maml:name> <maml:description> <maml:para>A reference to the role to set.</maml:para> </maml:description> <command:parameterValue required="true">RoleInfo</command:parameterValue> <dev:type> <maml:name>CMS.Membership.RoleInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The role name for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The role site id for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TaskGroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>TaskGroupName</maml:name> <maml:description> <maml:para>The task group name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the role to set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.Membership.RoleInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the role to set.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: RoleInfo --> <command:returnValue> <dev:type> <maml:name>CMS.Membership.RoleInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Set a new role to log staging tasks under specific task groups.</maml:para> </maml:introduction> <dev:code>Set-CMSRoleLog -Role $role -TaskGroupName "Group_Name"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Set a new role to log staging tasks under specific task groups.</maml:para> </maml:introduction> <dev:code>$role | Set-CMSRoleLog -TaskGroupName "Group_Name"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Set a new role to log staging tasks under specific task groups.</maml:para> </maml:introduction> <dev:code>Set-CMSRoleLog -RoleDisplayName "Role Display Name" -RoleName "Role Name" -SiteID "Site Id" -TaskGroupName "Group_Name"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CMSRoleNoLog --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CMSRoleNoLog</command:name> <command:verb>Set</command:verb> <command:noun>CMSRoleNoLog</command:noun> <maml:description> <maml:para>Sets a new role without logging any staging tasks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets a new role without logging any staging tasks.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Set-CMSRoleNoLog</maml:name> <!-- Parameter: RoleToSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RoleToSet</maml:name> <maml:description> <maml:para>A reference to the role to set.</maml:para> </maml:description> <command:parameterValue required="true">RoleInfo</command:parameterValue> <dev:type> <maml:name>CMS.Membership.RoleInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the role to set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Set-CMSRoleNoLog</maml:name> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The role name for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The role site id for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the role to set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: RoleToSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RoleToSet</maml:name> <maml:description> <maml:para>A reference to the role to set.</maml:para> </maml:description> <command:parameterValue required="true">RoleInfo</command:parameterValue> <dev:type> <maml:name>CMS.Membership.RoleInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RoleName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The role name for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The role site id for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the role to set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the role to set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.Membership.RoleInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the role to set.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: RoleInfo --> <command:returnValue> <dev:type> <maml:name>CMS.Membership.RoleInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Sets a new role without logging any staging tasks.</maml:para> </maml:introduction> <dev:code>Set-CMSRoleNoLog -Role $role</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Set a new role without logging any staging tasks.</maml:para> </maml:introduction> <dev:code>$role | Set-CMSRoleNoLog</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Set a new role without logging any staging tasks.</maml:para> </maml:introduction> <dev:code>Set-CMSRoleNoLog -RoleDisplayName "Role Display Name" -RoleName "Role Name" -SiteID "Site Id"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CMSServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CMSServer</command:name> <command:verb>Get</command:verb> <command:noun>CMSServer</command:noun> <maml:description> <maml:para>Gets the servers selected by the provided input.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the servers selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</maml:para> <maml:para></maml:para> <maml:para>Without parameters, this command returns all servers.</maml:para> <maml:para>With parameters, this command returns the servers that match the criteria.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Dislpay Name --> <command:syntaxItem> <maml:name>Get-CMSServer</maml:name> <!-- Parameter: SiteID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="ServerName"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the server to retrive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Get-CMSServer</maml:name> <!-- Parameter: Site --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>The associalted site for the server to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="ServerName"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the server to retrive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Get-CMSServer</maml:name> <!-- Parameter: ID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the server to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="ServerName"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the server to retrive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="ServerName"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The display name of the server to retrive.</maml:para> <maml:para>This is an alias of the DisplayName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Site --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>The associalted site for the server to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the server to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The associalted site for the server to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServerInfo[] --> <command:returnValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo[]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get all the servers.</maml:para> </maml:introduction> <dev:code>Get-CMSServer</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get all servers with a display name "*bas*", or server name "*bas*".</maml:para> </maml:introduction> <dev:code>Get-CMSServer bas</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get all servers with a site id 5, and a display name "*bas*" or server name "*bas*".</maml:para> </maml:introduction> <dev:code>Get-CMSServer -SiteID 5 -ServerName "bas"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Get all servers associalted with site $site with a display name "*bas*", or server name "*bas*"</maml:para> </maml:introduction> <dev:code>$site | Get-CMSServer bas</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <maml:introduction> <maml:para>Get all servers with a display name "basic", or server name "basic"</maml:para> </maml:introduction> <dev:code>Get-CMSServer basic -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <maml:introduction> <maml:para>Get all servers with a site id 5, and a display name "basic" or server name "basic"</maml:para> </maml:introduction> <dev:code>Get-CMSServer 5 basic -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <maml:introduction> <maml:para>Get all servers associalted with site $site with a display name "basic", or server name "basic"</maml:para> </maml:introduction> <dev:code>$site | Get-CMSServer basic -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <maml:introduction> <maml:para>Get all the servers with the specified IDs.</maml:para> </maml:introduction> <dev:code>Get-CMSServer -ID 5,304,5</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CMSServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CMSServer</command:name> <command:verb>New</command:verb> <command:noun>CMSServer</command:noun> <maml:description> <maml:para>Creates a new server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new server based off of the provided input.</maml:para> <maml:para>This cmdlet returns the newly created server when the -PassThru switch is used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>New-CMSServer</maml:name> <!-- Parameter: Site --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>The associalted site for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the newly created server.</maml:para> <maml:para>Server display name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The server name for the newly created server.</maml:para> <maml:para>If null, then the display name is used for the server name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: URL --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>URL</maml:name> <maml:description> <maml:para>The server url for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Authentication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Authentication</maml:name> <maml:description> <maml:para>The authentication for the newly created server.</maml:para> <maml:para>Possible values: UserName, X509</maml:para> </maml:description> <command:parameterValue required="true">ServerAuthenticationEnum</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerAuthenticationEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">X509</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>The enabled status for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>New-CMSServer</maml:name> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the newly created server.</maml:para> <maml:para>Server display name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The server name for the newly created server.</maml:para> <maml:para>If null, then the display name is used for the server name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: URL --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>URL</maml:name> <maml:description> <maml:para>The server url for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Authentication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Authentication</maml:name> <maml:description> <maml:para>The authentication for the newly created server.</maml:para> <maml:para>Possible values: UserName, X509</maml:para> </maml:description> <command:parameterValue required="true">ServerAuthenticationEnum</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerAuthenticationEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">X509</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>The enabled status for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Site --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>The associalted site for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the newly created server.</maml:para> <maml:para>Server display name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The server name for the newly created server.</maml:para> <maml:para>If null, then the display name is used for the server name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: URL --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>URL</maml:name> <maml:description> <maml:para>The server url for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Authentication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Authentication</maml:name> <maml:description> <maml:para>The authentication for the newly created server.</maml:para> <maml:para>Possible values: UserName, X509</maml:para> </maml:description> <command:parameterValue required="true">ServerAuthenticationEnum</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerAuthenticationEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">X509</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>The enabled status for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the newly created server.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The associalted site for the newly created server.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServerInfo --> <command:returnValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Create a new server specifying the display name and Url, and associated site id.</maml:para> </maml:introduction> <dev:code>New-CMSServer -DisplayName "My Test Name" -URL "My Server Url" -SiteID 5</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Create a new server specifying the display name and Url, and associate it to $site.</maml:para> </maml:introduction> <dev:code>$site | New-CMSServer -DisplayName "My Test Name" -URL "My Server Url"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Create a new server specifying the display name, server name, url, authentication, enabled, user name and password, and associated site id.</maml:para> </maml:introduction> <dev:code>New-CMSServer -DisplayName "My Test Name" -ServerName "My Server Name" -URL "My Server Url" -Authentication UserName -Enabled True -UserName "My User Name" -Password "My Password" -SiteID 5</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Create a new server specifying the display name, server name, url, authentication, enabled, user name and password, and associate it to $site.</maml:para> </maml:introduction> <dev:code>$site | New-CMSServer -DisplayName "My Test Name" -ServerName "My Server Name" -URL "My Server Url" -Authentication UserName -Enabled True -UserName "My User Name" -Password "My Password"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CMSServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CMSServer</command:name> <command:verb>Remove</command:verb> <command:noun>CMSServer</command:noun> <maml:description> <maml:para>Removes the servers selected by the provided input.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the servers selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Dislpay Name --> <command:syntaxItem> <maml:name>Remove-CMSServer</maml:name> <!-- Parameter: SiteID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="ServerName"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the server to retrive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Remove-CMSServer</maml:name> <!-- Parameter: Site --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>The associalted site for the server to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="ServerName"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the server to retrive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Remove-CMSServer</maml:name> <!-- Parameter: ID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the server to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Site --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>The associalted site for the server to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="ServerName"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the server to retrive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="ServerName"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The display name of the server to retrive.</maml:para> <maml:para>This is an alias of the DisplayName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the server to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The associalted site for the server to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove all servers with a display name "*bas*", or server name "*bas*".</maml:para> </maml:introduction> <dev:code>Remove-CMSServer bas</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Remove all servers with a site id 5, and a display name "*bas*" or server name "*bas*".</maml:para> </maml:introduction> <dev:code>Remove-CMSServer -SiteID 5 -ServerName "bas"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Remove all servers associalted with site $site with a display name "*bas*", or server name "*bas*"</maml:para> </maml:introduction> <dev:code>$site | Remove-CMSServer bas</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Remove all servers with a display name "basic", or server name "basic"</maml:para> </maml:introduction> <dev:code>Remove-CMSServer basic -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <maml:introduction> <maml:para>Remove all servers with a site id 5, and a display name "basic" or server name "basic"</maml:para> </maml:introduction> <dev:code>Remove-CMSServer -SiteID 5 -ServerName "basic" -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <maml:introduction> <maml:para>Remove all servers associalted with site $site with a display name "basic", or server name "basic"</maml:para> </maml:introduction> <dev:code>$site | Remove-CMSServer basic -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <maml:introduction> <maml:para>Remove all the servers with the specified IDs.</maml:para> </maml:introduction> <dev:code>Remove-CMSServer -ID 5,304,5</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CMSServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CMSServer</command:name> <command:verb>Set</command:verb> <command:noun>CMSServer</command:noun> <maml:description> <maml:para>Sets a server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets a new server based off of the provided input.</maml:para> <maml:para>This cmdlet returns the server to update when the -PassThru switch is used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Set-CMSServer</maml:name> <!-- Parameter: ServerToSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Server"> <maml:name>ServerToSet</maml:name> <maml:description> <maml:para>A reference to the server to update.</maml:para> </maml:description> <command:parameterValue required="true">ServerInfo</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the server to update.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Set-CMSServer</maml:name> <!-- Parameter: ServerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The server name for the server to update.</maml:para> <maml:para>If null, then the display name is used for the server name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the server to update.</maml:para> <maml:para>Server display name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: URL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>URL</maml:name> <maml:description> <maml:para>The server url for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Authentication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Authentication</maml:name> <maml:description> <maml:para>The authentication for the server to update.</maml:para> <maml:para>Possible values: UserName, X509</maml:para> </maml:description> <command:parameterValue required="true">ServerAuthenticationEnum</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerAuthenticationEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">X509</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>The enabled status for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the server to update.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServerToSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Server"> <maml:name>ServerToSet</maml:name> <maml:description> <maml:para>A reference to the server to update.</maml:para> </maml:description> <command:parameterValue required="true">ServerInfo</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Server"> <maml:name>Server</maml:name> <maml:description> <maml:para>A reference to the server to update.</maml:para> <maml:para>This is an alias of the ServerToSet parameter.</maml:para> </maml:description> <command:parameterValue required="true">ServerInfo</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The server name for the server to update.</maml:para> <maml:para>If null, then the display name is used for the server name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the server to update.</maml:para> <maml:para>Server display name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: URL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>URL</maml:name> <maml:description> <maml:para>The server url for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Authentication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Authentication</maml:name> <maml:description> <maml:para>The authentication for the server to update.</maml:para> <maml:para>Possible values: UserName, X509</maml:para> </maml:description> <command:parameterValue required="true">ServerAuthenticationEnum</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerAuthenticationEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">X509</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>The enabled status for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the server to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the server to update.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the server to update.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServerInfo --> <command:returnValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Set server specifying an existing server.</maml:para> </maml:introduction> <dev:code>Set-CMSServer -Server $server</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Set server specifying an existing server.</maml:para> </maml:introduction> <dev:code>$server | Set-CMSServer</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get server specifying the ServerName and SiteID, Set its DisplayName, URL, Authentication, Enabled, UserName, Password.</maml:para> </maml:introduction> <dev:code>Set-CMSServer -ServerName "Server Name to find" -SiteID "Site ID to find" -DisplayName "New Display Name" -URL "New URL" -Authentication "UserName or X509" -Enabled "True or False" -UserName "New User Name" -Password "New Password"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CMSSettingValue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CMSSettingValue</command:name> <command:verb>Get</command:verb> <command:noun>CMSSettingValue</command:noun> <maml:description> <maml:para>Gets the setting values by the provided setting key.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the setting values by the provided setting key.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Get-CMSSettingValue</maml:name> <!-- Parameter: Site --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site to get setting from.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the setting to get value from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Get-CMSSettingValue</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name of the site to get setting from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the setting to get value from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: None --> <command:syntaxItem> <maml:name>Get-CMSSettingValue</maml:name> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the setting to get value from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Site --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site to get setting from.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name of the site to get setting from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the setting to get value from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site to get setting from.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The site name of the site to get setting from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get all setting values with a site, and setting key "key".</maml:para> </maml:introduction> <dev:code>$site | Get-CMSSettingValue -Key "my key"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get all setting values with a site name "site", and setting key "key".</maml:para> </maml:introduction> <dev:code>Get-CMSSettingValue -SiteName "my site" -Key "my key"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CMSSettingValue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CMSSettingValue</command:name> <command:verb>Set</command:verb> <command:noun>CMSSettingValue</command:noun> <maml:description> <maml:para>Sets the setting values by the provided setting key.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the setting values by the provided setting key.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Set-CMSSettingValue</maml:name> <!-- Parameter: Site --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site to set setting for.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the setting to set value for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the setting to set value for.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Set-CMSSettingValue</maml:name> <!-- Parameter: SiteName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name of the site to set setting for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the setting to set value for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the setting to set value for.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: None --> <command:syntaxItem> <maml:name>Set-CMSSettingValue</maml:name> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the setting to set value for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the setting to set value for.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Site --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site to set setting for.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name of the site to set setting for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the setting to set value for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the setting to set value for.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site to set setting for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The site name of the site to set setting for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Set setting values with a new value "new val", for setting with a site, and setting key "key".</maml:para> </maml:introduction> <dev:code>$site | Set-CMSSettingValue -Key "my key" -Value "new val"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Set setting values with a new value "new val", for setting with site name "site", and setting key "key".</maml:para> </maml:introduction> <dev:code>Set-CMSSettingValue -SiteName "my site" -Key "my key" -Value "new val"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CMSSite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CMSSite</command:name> <command:verb>Get</command:verb> <command:noun>CMSSite</command:noun> <maml:description> <maml:para>Gets the sites selected by the provided input.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the sites selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</maml:para> <maml:para></maml:para> <maml:para>Without parameters, this command returns all sites.</maml:para> <maml:para>With parameters, this command returns the sites that match the criteria.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Dislpay Name --> <command:syntaxItem> <maml:name>Get-CMSSite</maml:name> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="SiteName,DomainName"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the site to retrive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Get-CMSSite</maml:name> <!-- Parameter: ID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="SiteName,DomainName"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the site to retrive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="SiteName,DomainName"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The display name of the site to retrive.</maml:para> <maml:para>This is an alias of the DisplayName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="SiteName,DomainName"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The display name of the site to retrive.</maml:para> <maml:para>This is an alias of the DisplayName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The display name of the site to retrive.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SiteInfo[] --> <command:returnValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo[]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get all the sites.</maml:para> </maml:introduction> <dev:code>Get-CMSSite</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get all sites with a display name "*bas*", site name "*bas*", or a domain name "bas*".</maml:para> </maml:introduction> <dev:code>Get-CMSSite bas</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get all sites with a display name "basic", site name "basic", or domain name "basic"</maml:para> </maml:introduction> <dev:code>Get-CMSSite basic -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Get all the sites with the specified IDs.</maml:para> </maml:introduction> <dev:code>Get-CMSSite -ID 5,304,5</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CMSSite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CMSSite</command:name> <command:verb>New</command:verb> <command:noun>CMSSite</command:noun> <maml:description> <maml:para>Creates a new site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new site based off of the provided input.</maml:para> <maml:para>This cmdlet returns the newly created site when the -PassThru switch is used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: PassThru --> <command:syntaxItem> <maml:name>New-CMSSite</maml:name> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the newly created site.</maml:para> <maml:para>Site display name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the newly created site.</maml:para> <maml:para>If null, then the display name is used for the site name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status for the newly created site.</maml:para> <maml:para>Possible values: Running, Stopped</maml:para> </maml:description> <command:parameterValue required="true">SiteStatusEnum</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteStatusEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Running</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stopped</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DomainName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The domain name for the newly created site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the newly created site.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the newly created site.</maml:para> <maml:para>Site display name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the newly created site.</maml:para> <maml:para>If null, then the display name is used for the site name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status for the newly created site.</maml:para> <maml:para>Possible values: Running, Stopped</maml:para> </maml:description> <command:parameterValue required="true">SiteStatusEnum</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteStatusEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Running</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stopped</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DomainName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The domain name for the newly created site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the newly created site.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: SiteInfo --> <command:returnValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Create a new site specifying the display name and domain name.</maml:para> </maml:introduction> <dev:code>New-CMSSite -DisplayName "My Test Name" -DomainName "My Domain Name"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Create a new site specifying the display name, site name, status, and domain name.</maml:para> </maml:introduction> <dev:code>New-CMSSite -DisplayName "My Test Name" -SiteName "My Site Name" -Status "Running or Stopped" -DomainName "My Domain Name"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CMSSite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CMSSite</command:name> <command:verb>Remove</command:verb> <command:noun>CMSSite</command:noun> <maml:description> <maml:para>Deletes a site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes a site.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Remove-CMSSite</maml:name> <!-- Parameter: SiteToRemove --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToRemove</maml:name> <maml:description> <maml:para>A reference to the site to remove.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Remove-CMSSite</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site to remove.</maml:para> <maml:para>Site name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Remove-CMSSite</maml:name> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to delete.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteToRemove --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToRemove</maml:name> <maml:description> <maml:para>A reference to the site to remove.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site to remove.</maml:para> <maml:para>This is an alias of the SiteToRemove parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site to remove.</maml:para> <maml:para>Site name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to delete.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site to remove.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The site name for the site to remove.</maml:para> <maml:para>Site name cannot be blank.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Deletes all sites contains a site name "*bas*", display name "*bas*", or a domain name "*bas*".</maml:para> </maml:introduction> <dev:code>Remove-CMSSite -SiteName "bas"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Deletes all sites with a site name "basic", display name "basic", or a domain name "basic".</maml:para> </maml:introduction> <dev:code>Remove-CMSSite -SiteName "basic" -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Deletes a site.</maml:para> </maml:introduction> <dev:code>$site | Remove-CMSSite</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Delete all the sites with the specified IDs.</maml:para> </maml:introduction> <dev:code>Remove-CMSSite -ID 1,2,3</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CMSSite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CMSSite</command:name> <command:verb>Set</command:verb> <command:noun>CMSSite</command:noun> <maml:description> <maml:para>Sets a site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets a new site based off of the provided input.</maml:para> <maml:para>This cmdlet returns the site to update when the -PassThru switch is used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Set-CMSSite</maml:name> <!-- Parameter: SiteToSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToSet</maml:name> <maml:description> <maml:para>A reference to the site to update.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the site to update.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Set-CMSSite</maml:name> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the site to update.</maml:para> <maml:para>Site display name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site to update.</maml:para> <maml:para>Site name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status for the site to update.</maml:para> <maml:para>Possible values: Running, Stopped</maml:para> </maml:description> <command:parameterValue required="true">SiteStatusEnum</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteStatusEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Running</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stopped</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DomainName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The domain name for the site to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the site to update.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteToSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToSet</maml:name> <maml:description> <maml:para>A reference to the site to update.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site to update.</maml:para> <maml:para>This is an alias of the SiteToSet parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the site to update.</maml:para> <maml:para>Site display name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site to update.</maml:para> <maml:para>Site name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status for the site to update.</maml:para> <maml:para>Possible values: Running, Stopped</maml:para> </maml:description> <command:parameterValue required="true">SiteStatusEnum</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteStatusEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Running</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stopped</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DomainName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The domain name for the site to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the site to update.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site to update.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SiteInfo --> <command:returnValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Set site specifying an existing site.</maml:para> </maml:introduction> <dev:code>Set-CMSSite -Site $site</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Set site specifying an existing site.</maml:para> </maml:introduction> <dev:code>$site | Set-CMSSite</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Set site specifying the display name, site name, status, and domain name.</maml:para> </maml:introduction> <dev:code>Set-CMSSite -DisplayName "My Test Name" -SiteName "My Site Name" -Status "Running or Stopped" -DomainName "My Domain Name"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-CMSSite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-CMSSite</command:name> <command:verb>Start</command:verb> <command:noun>CMSSite</command:noun> <maml:description> <maml:para>Starts a site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts a site.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Start-CMSSite</maml:name> <!-- Parameter: SiteToStart --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToStart</maml:name> <maml:description> <maml:para>A reference to the site to start.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Start-CMSSite</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site to start.</maml:para> <maml:para>Site name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Start-CMSSite</maml:name> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to start.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteToStart --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToStart</maml:name> <maml:description> <maml:para>A reference to the site to start.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site to start.</maml:para> <maml:para>This is an alias of the SiteToStart parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site to start.</maml:para> <maml:para>Site name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to start.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site to start.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Starts a site contains a site name "*bas*", display name "*bas*", or a domain name "bas*".</maml:para> </maml:introduction> <dev:code>Start-CMSSite -SiteName "bas"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Starts a site with a site name "basic", display name "basic", or a domain name "basic".</maml:para> </maml:introduction> <dev:code>Start-CMSSite -Site "basic" -EXACT</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Starts a site.</maml:para> </maml:introduction> <dev:code>$site| Start-CMSSite</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Starts all the sites with the specified IDs.</maml:para> </maml:introduction> <dev:code>Start-CMSSite -ID 1,2,3</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Stop-CMSSite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-CMSSite</command:name> <command:verb>Stop</command:verb> <command:noun>CMSSite</command:noun> <maml:description> <maml:para>Stops a site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stops a site.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Stop-CMSSite</maml:name> <!-- Parameter: SiteToStart --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToStart</maml:name> <maml:description> <maml:para>A reference to the site to stop.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Stop-CMSSite</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site to stop.</maml:para> <maml:para>Site name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Stop-CMSSite</maml:name> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to stop.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteToStart --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToStart</maml:name> <maml:description> <maml:para>A reference to the site to stop.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site to stop.</maml:para> <maml:para>This is an alias of the SiteToStart parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site to stop.</maml:para> <maml:para>Site name cannot be blank.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to stop.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site to stop.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Stops a site contains a site name "*bas*", display name "*bas*", or a domain name "bas*".</maml:para> </maml:introduction> <dev:code>Stop-CMSSite -SiteName "bas"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Stops a site with a site name "basic", display name "basic", or a domain name "basic".</maml:para> </maml:introduction> <dev:code>Stop-CMSSite -Site "basic" -EXACT</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Stops a site.</maml:para> </maml:introduction> <dev:code>$site| Stop-CMSSite</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Stops all the sites with the specified IDs.</maml:para> </maml:introduction> <dev:code>Stop-CMSSite -ID 1,2,3</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-CMSSiteCulture --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-CMSSiteCulture</command:name> <command:verb>Add</command:verb> <command:noun>CMSSiteCulture</command:noun> <maml:description> <maml:para>Adds a culture to a specified site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a culture to a specified site based off of the provided input.</maml:para> <maml:para>This cmdlet returns the newly modified site when the -PassThru switch is used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Add-CMSSiteCulture</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteToAdd --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToAdd</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CultureCode --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CultureCode</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Add-CMSSiteCulture</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CultureCode --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CultureCode</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Add-CMSSiteCulture</maml:name> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CultureCode --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CultureCode</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteToAdd --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToAdd</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> <maml:para>This is an alias of the SiteToAdd parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CultureCode --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CultureCode</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add a culture with culture code "cul" to a specified site specifying the site name "*bas*", display name "*bas*", or a domain name "*bas*".</maml:para> </maml:introduction> <dev:code>Add-CMSSiteCulture -SiteName "*bas*" -CultureCode "cul"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Add a culture with culture code "cul" to a specified site specifying the site name "basic", display name "basic", or a domain name "basic".</maml:para> </maml:introduction> <dev:code>Add-CMSSiteCulture -SiteName "basic" -EXACT -CultureCode "cul"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Add a culture with culture code "cul" to a site.</maml:para> </maml:introduction> <dev:code>$site | Add-CMSSiteCulture -CultureCode "cul"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Add a culture with culture code "cul" with the specified site IDs.</maml:para> </maml:introduction> <dev:code>Add-CMSSiteCulture -ID 1,2,3 -CultureCode "cul"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CMSSiteCulture --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CMSSiteCulture</command:name> <command:verb>Get</command:verb> <command:noun>CMSSiteCulture</command:noun> <maml:description> <maml:para>Gets the cultures of the specified site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the cultures of the specified site based off of the provided input.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Get-CMSSiteCulture</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Get-CMSSiteCulture</maml:name> <!-- Parameter: SiteToWork --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToWork</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteToWork --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToWork</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> <maml:para>This is an alias of the SiteToWork parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CultureInfo[] --> <command:returnValue> <dev:type> <maml:name>CMS.Localization.CultureInfo[]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Gets the cultures of a site specifying the site name "basic".</maml:para> </maml:introduction> <dev:code>Get-CMSSiteCulture -SiteName "basic" </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Gets the cultures of a site passing the site to the cmdlet.</maml:para> </maml:introduction> <dev:code>$site | Get-CMSSiteCulture</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CMSSiteCulture --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CMSSiteCulture</command:name> <command:verb>Remove</command:verb> <command:noun>CMSSiteCulture</command:noun> <maml:description> <maml:para>Removes a culture to a specified site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a culture to a specified site based off of the provided input.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Remove-CMSSiteCulture</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteToRemove --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToRemove</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CultureCode --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CultureCode</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Remove-CMSSiteCulture</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CultureCode --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CultureCode</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Remove-CMSSiteCulture</maml:name> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CultureCode --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CultureCode</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteToRemove --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToRemove</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> <maml:para>This is an alias of the SiteToRemove parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CultureCode --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CultureCode</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove a culture with culture code "cul" from a specified site specifying the site name "*bas*", display name "*bas*", or a domain name "*bas*".</maml:para> </maml:introduction> <dev:code>Remove-CMSSiteCulture -SiteName "*bas*" -CultureCode "cul"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Remove a culture with culture code "cul" from a specified site specifying the site name "basic", display name "basic", or a domain name "basic".</maml:para> </maml:introduction> <dev:code>Remove-CMSSiteCulture -SiteName "basic" -EXACT -CultureCode "cul"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Remove a culture with culture code "cul" from a site.</maml:para> </maml:introduction> <dev:code>$site | Remove-CMSSiteCulture</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Remove a culture with culture code "cul" with the specified IDs.</maml:para> </maml:introduction> <dev:code>Remove-CMSSiteCulture -ID 1,2,3</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-CMSSiteDomainAlias --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-CMSSiteDomainAlias</command:name> <command:verb>Add</command:verb> <command:noun>CMSSiteDomainAlias</command:noun> <maml:description> <maml:para>Adds a domain alias to a specified site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a domain alias to a specified site based off of the provided input.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Add-CMSSiteDomainAlias</maml:name> <!-- Parameter: SiteToAdd --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToAdd</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AliasName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Add-CMSSiteDomainAlias</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AliasName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Add-CMSSiteDomainAlias</maml:name> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AliasName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteToAdd --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToAdd</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> <maml:para>This is an alias of the SiteToAdd parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AliasName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add a domain alias with alias name "alias" to a specified site specifying the site name "*bas*", display name "*bas*", or a domain name "*bas*".</maml:para> </maml:introduction> <dev:code>Add-CMSSiteDomainAlias -SiteName "*bas*" -AliasName "alias"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Add a domain alias with alias name "alias" to a specified site specifying the site name "basic", display name "basic", or a domain name "basic".</maml:para> </maml:introduction> <dev:code>Add-CMSSiteDomainAlias -SiteName "basic" -EXACT -AliasName "alias"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Add a domain alias with alias name "alias" to a site.</maml:para> </maml:introduction> <dev:code>$site | Add-CMSSiteDomainAlias -AliasName "alias"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Add a domain alias with alias name "alias" with the specified site IDs.</maml:para> </maml:introduction> <dev:code>Add-CMSSiteDomainAlias -ID 1,2,3 -AliasName "alias"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CMSSiteDomainAlias --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CMSSiteDomainAlias</command:name> <command:verb>Get</command:verb> <command:noun>CMSSiteDomainAlias</command:noun> <maml:description> <maml:para>Gets the domain aliases of the specified site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the domain aliases of the specified site based off of the provided input.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Get-CMSSiteDomainAlias</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Get-CMSSiteDomainAlias</maml:name> <!-- Parameter: SiteToWork --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToWork</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteToWork --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToWork</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> <maml:para>This is an alias of the SiteToWork parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SiteDomainAliasInfo[] --> <command:returnValue> <dev:type> <maml:name>CMS.SiteProvider.SiteDomainAliasInfo[]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Gets the domain aliases of a site specifying the site name "basic".</maml:para> </maml:introduction> <dev:code>Get-CMSSiteDomainAlias -SiteName "basic" </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Gets the domain aliases of a site passing the site to the cmdlet.</maml:para> </maml:introduction> <dev:code>$site | Get-CMSSiteDomainAlias</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CMSSiteDomainAlias --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CMSSiteDomainAlias</command:name> <command:verb>Remove</command:verb> <command:noun>CMSSiteDomainAlias</command:noun> <maml:description> <maml:para>Removes a domain alias to a specified site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a domain alias to a specified site based off of the provided input.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Remove-CMSSiteDomainAlias</maml:name> <!-- Parameter: SiteToRemove --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToRemove</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AliasName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Remove-CMSSiteDomainAlias</maml:name> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AliasName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Remove-CMSSiteDomainAlias</maml:name> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AliasName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SiteToRemove --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>SiteToRemove</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Site"> <maml:name>Site</maml:name> <maml:description> <maml:para>A reference to the site.</maml:para> <maml:para>This is an alias of the SiteToRemove parameter.</maml:para> </maml:description> <command:parameterValue required="true">SiteInfo</command:parameterValue> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The site name for the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for site name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AliasName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>The IDs of the site.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.SiteProvider.SiteInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the site.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove a domain alias with alias name "alias" to a specified site specifying the site name "*bas*", display name "*bas*", or a domain name "*bas*".</maml:para> </maml:introduction> <dev:code>Remove-CMSSiteDomainAlias -SiteName "*bas*" -AliasName "alias"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Remove a domain alias with alias name "alias" to a specified site specifying the site name "basic", display name "basic", or a domain name "basic".</maml:para> </maml:introduction> <dev:code>Remove-CMSSiteDomainAlias -SiteName "basic" -EXACT -AliasName "alias"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Remove a domain alias with alias name "alias" to a site.</maml:para> </maml:introduction> <dev:code>$site | Remove-CMSSiteDomainAlias -AliasName "alias"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Remove a domain alias with alias name "alias" with the specified site IDs.</maml:para> </maml:introduction> <dev:code>Remove-CMSSiteDomainAlias -ID 1,2,3 -AliasName "alias"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CMSStagingTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CMSStagingTask</command:name> <command:verb>Remove</command:verb> <command:noun>CMSStagingTask</command:noun> <maml:description> <maml:para>Remove the staging tasks that target the given server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the staging tasks that target the given server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Remove-CMSStagingTask</maml:name> <!-- Parameter: ServerToRemove --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Server"> <maml:name>ServerToRemove</maml:name> <maml:description> <maml:para>A reference to the server to remove all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">ServerInfo</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Remove-CMSStagingTask</maml:name> <!-- Parameter: ServerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The server name for the server to remove all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to remove all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServerToRemove --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Server"> <maml:name>ServerToRemove</maml:name> <maml:description> <maml:para>A reference to the server to remove all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">ServerInfo</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Server"> <maml:name>Server</maml:name> <maml:description> <maml:para>A reference to the server to remove all related staging tasks.</maml:para> <maml:para>This is an alias of the ServerToRemove parameter.</maml:para> </maml:description> <command:parameterValue required="true">ServerInfo</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The server name for the server to remove all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to remove all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the server to remove all related staging tasks.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Given an existing server and synchronize all related staging tasks.</maml:para> </maml:introduction> <dev:code>Remove-CMSStagingTask -Server $server</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Given an existing server and synchronize all related staging tasks.</maml:para> </maml:introduction> <dev:code>$server | Remove-CMSStagingTask</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get a server by ServerName and SiteID, and synchronize all related staging tasks.</maml:para> </maml:introduction> <dev:code>Remove-CMSStagingTask -ServerName "Server Name to Find" -SiteID "Site Id to Find"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Sync-CMSStagingTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Sync-CMSStagingTask</command:name> <command:verb>Sync</command:verb> <command:noun>CMSStagingTask</command:noun> <maml:description> <maml:para>Synchronize the staging tasks that target the given server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Synchronize the staging tasks that target the given server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Object --> <command:syntaxItem> <maml:name>Sync-CMSStagingTask</maml:name> <!-- Parameter: ServerToSync --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Server"> <maml:name>ServerToSync</maml:name> <maml:description> <maml:para>A reference to the server to sync all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">ServerInfo</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Property --> <command:syntaxItem> <maml:name>Sync-CMSStagingTask</maml:name> <!-- Parameter: ServerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The server name for the server to sync all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to sync all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServerToSync --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Server"> <maml:name>ServerToSync</maml:name> <maml:description> <maml:para>A reference to the server to sync all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">ServerInfo</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Server"> <maml:name>Server</maml:name> <maml:description> <maml:para>A reference to the server to sync all related staging tasks.</maml:para> <maml:para>This is an alias of the ServerToSync parameter.</maml:para> </maml:description> <command:parameterValue required="true">ServerInfo</command:parameterValue> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The server name for the server to sync all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SiteID</maml:name> <maml:description> <maml:para>The server site id for the server to sync all related staging tasks.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.Synchronization.ServerInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the server to sync all related staging tasks.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Given an existing server and synchronize all related staging tasks.</maml:para> </maml:introduction> <dev:code>Sync-CMSStagingTask -Server $server</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Given an existing server and synchronize all related staging tasks.</maml:para> </maml:introduction> <dev:code>$server | Sync-CMSStagingTask</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get a server by ServerName and SiteID, and synchronize all related staging tasks.</maml:para> </maml:introduction> <dev:code>Sync-CMSStagingTask -ServerName "Server Name to Find" -SiteID "Site Id to Find"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CMSWebConfigValue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CMSWebConfigValue</command:name> <command:verb>Get</command:verb> <command:noun>CMSWebConfigValue</command:noun> <maml:description> <maml:para>Gets the web.config setting value by the provided setting key.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the web.config setting values by the provided setting key or default value if not.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CMSWebConfigValue</maml:name> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the web.config setting to retrive value from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Default</maml:name> <maml:description> <maml:para>The default value for the setting.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the web.config setting to retrive value from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Default</maml:name> <maml:description> <maml:para>The default value for the setting.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The key of the web.config setting to retrive value from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get web.config setting values with a key.</maml:para> </maml:introduction> <dev:code>Get-CMSSettingValue -Key "my key"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get web.config setting values with a key and a culture.</maml:para> </maml:introduction> <dev:code>Get-CMSSettingValue -Key "my key" -Default "the default value"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CMSWebPartCategory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CMSWebPartCategory</command:name> <command:verb>Get</command:verb> <command:noun>CMSWebPartCategory</command:noun> <maml:description> <maml:para>Gets the web part categories selected by the provided input.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the web part categories selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</maml:para> <maml:para></maml:para> <maml:para>Without parameters, this command returns all webpart categories.</maml:para> <maml:para>With parameters, this command returns the webpart categories that match the criteria.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Category Name --> <command:syntaxItem> <maml:name>Get-CMSWebPartCategory</maml:name> <!-- Parameter: CategoryName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Get-CMSWebPartCategory</maml:name> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CategoryName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> <maml:para>This is an alias of the CategoryName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>Name</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> <maml:para>This is an alias of the CategoryName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> <maml:para>This is an alias of the CategoryName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebPartCategoryInfo --> <command:returnValue> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get all the webpart categories.</maml:para> </maml:introduction> <dev:code>Get-CMSWebPartCategory</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get all webparts with a category name "*bas*", display name "*bas*", or a path "bas*".</maml:para> </maml:introduction> <dev:code>Get-CMSWebPartCategory bas</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get all webparts with a category name "basic", display name "basic", or path "basic"</maml:para> </maml:introduction> <dev:code>Get-CMSWebPartCategory basic -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Get all the webparts with the specified IDs.</maml:para> </maml:introduction> <dev:code>Get-CMSWebPartCategory -ID 5,304,5</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CMSWebPartCategory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CMSWebPartCategory</command:name> <command:verb>New</command:verb> <command:noun>CMSWebPartCategory</command:noun> <maml:description> <maml:para>Creates a new web part category.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new web part category based off of the provided input.</maml:para> <maml:para>This cmdlet returns the newly created web part category when the -PassThru switch is used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: PassThru --> <command:syntaxItem> <maml:name>New-CMSWebPartCategory</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to create the new web part category at.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the newly created web part category.</maml:para> <maml:para>If null, then the name portion of the path is used for the display name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ImagePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="IconPath"> <maml:name>ImagePath</maml:name> <maml:description> <maml:para>The path for the icon for the newly created web part category.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the newly created web part category.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the newly created web part category.</maml:para> <maml:para>If null, then the name portion of the path is used for the display name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to create the new web part category at.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ImagePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="IconPath"> <maml:name>ImagePath</maml:name> <maml:description> <maml:para>The path for the icon for the newly created web part category.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="IconPath"> <maml:name>IconPath</maml:name> <maml:description> <maml:para>The path for the icon for the newly created web part category.</maml:para> <maml:para>This is an alias of the ImagePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the newly created web part category.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: WebPartCategoryInfo --> <command:returnValue> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Create a new web part category implying the display name.</maml:para> </maml:introduction> <dev:code>New-CMSWebPartCategory -Path /Test/Test1</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Create a new web part category specifying the display name.</maml:para> </maml:introduction> <dev:code>New-CMSWebPartCategory -Path /Test/Test1 -DisplayName "My Test Category"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CMSWebPartCategory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CMSWebPartCategory</command:name> <command:verb>Remove</command:verb> <command:noun>CMSWebPartCategory</command:noun> <maml:description> <maml:para>Deletes the web part categories selected by the provided input.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the web part categories selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</maml:para> <maml:para></maml:para> <maml:para>This command deletes the webpart categories that match the criteria.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Category Name --> <command:syntaxItem> <maml:name>Remove-CMSWebPartCategory</maml:name> <!-- Parameter: CategoryName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ID --> <command:syntaxItem> <maml:name>Remove-CMSWebPartCategory</maml:name> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to delete.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Web Part Category --> <command:syntaxItem> <maml:name>Remove-CMSWebPartCategory</maml:name> <!-- Parameter: WebPartCategory --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Category"> <maml:name>WebPartCategory</maml:name> <maml:description> <maml:para>A reference to the WebPart category to delete.</maml:para> </maml:description> <command:parameterValue required="true">WebPartCategoryInfo</command:parameterValue> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CategoryName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> <maml:para>This is an alias of the CategoryName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>Name</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> <maml:para>This is an alias of the CategoryName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="DisplayName,Name,Path"> <maml:name>Path</maml:name> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> <maml:para>This is an alias of the CategoryName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Exact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exact</maml:name> <maml:description> <maml:para>If set, the match is exact,</maml:para> <maml:para>else the match performs a contains for display name and category name and starts with for path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ID</maml:name> <maml:description> <maml:para>The IDs of the web part category to delete.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WebPartCategory --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Category"> <maml:name>WebPartCategory</maml:name> <maml:description> <maml:para>A reference to the WebPart category to delete.</maml:para> </maml:description> <command:parameterValue required="true">WebPartCategoryInfo</command:parameterValue> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Category"> <maml:name>Category</maml:name> <maml:description> <maml:para>A reference to the WebPart category to delete.</maml:para> <maml:para>This is an alias of the WebPartCategory parameter.</maml:para> </maml:description> <command:parameterValue required="true">WebPartCategoryInfo</command:parameterValue> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The category name, display name, or path of the webpart category.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the WebPart category to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Delete all the webpart categories.</maml:para> </maml:introduction> <dev:code>Get-CMSWebPartCategory | Remove-CMSWebPartCategory</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Delete all webparts with a category name "*bas*", display name "*bas*", or a path "bas*".</maml:para> </maml:introduction> <dev:code>Remove-CMSWebPartCategory bas</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Delete all webparts with a category name "basic", display name "basic", or path "basic"</maml:para> </maml:introduction> <dev:code>Remove-CMSWebPartCategory basic -Exact</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Delete all the webparts with the specified IDs.</maml:para> </maml:introduction> <dev:code>Remove-CMSWebPartCategory -ID 5,304,5</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CMSWebPartCategory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CMSWebPartCategory</command:name> <command:verb>Set</command:verb> <command:noun>CMSWebPartCategory</command:noun> <maml:description> <maml:para>Sets a web part category.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets a web part category.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: PassThru --> <command:syntaxItem> <maml:name>Set-CMSWebPartCategory</maml:name> <!-- Parameter: WebPartCategory --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Category"> <maml:name>WebPartCategory</maml:name> <maml:description> <maml:para>A reference to the WebPart category to update.</maml:para> </maml:description> <command:parameterValue required="true">WebPartCategoryInfo</command:parameterValue> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the newly created web part category.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WebPartCategory --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Category"> <maml:name>WebPartCategory</maml:name> <maml:description> <maml:para>A reference to the WebPart category to update.</maml:para> </maml:description> <command:parameterValue required="true">WebPartCategoryInfo</command:parameterValue> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Category"> <maml:name>Category</maml:name> <maml:description> <maml:para>A reference to the WebPart category to update.</maml:para> <maml:para>This is an alias of the WebPartCategory parameter.</maml:para> </maml:description> <command:parameterValue required="true">WebPartCategoryInfo</command:parameterValue> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Tell the cmdlet to return the newly created web part category.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A reference to the WebPart category to update.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: WebPartCategoryInfo --> <command:returnValue> <dev:type> <maml:name>CMS.PortalEngine.WebPartCategoryInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Sets a web part category.</maml:para> </maml:introduction> <dev:code>$webPartCategory | Set-CMSWebPartCategory</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Sets a web part category and returns the result.</maml:para> </maml:introduction> <dev:code>$webPartCategory | Set-CMSWebPartCategory -Passthru</dev:code> </command:example> </command:examples> </command:command> </helpItems> |