BinaryTree.Power365.Cmdlet.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-BTCutover --> <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-BTCutover</command:name> <command:verb>Get</command:verb> <command:noun>BTCutover</command:noun> <maml:description> <maml:para>Returns the statuses of Power365 Cutover operations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTCutover -Identity returns the Cutover identified by its CutoverJobId, or a Cutover object.</maml:para> <maml:para>Get-BTCutover [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Cutovers matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTCutover</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Cutover identity: CutoverJobId, or Cutover object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTCutover</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are CutoverJobId, UserId, CutoverState, DSCutoverState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</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> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Cutover identity: CutoverJobId, or Cutover object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</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> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are CutoverJobId, UserId, CutoverState, DSCutoverState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Cutover identity: CutoverJobId, or Cutover object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CutoverJob --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CutoverJob</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-BTCutover -Identity 986</maml:para> <maml:para>Get-BTCutover -Identity $cutover</maml:para> <maml:para>Returns a Cutover by CutoverJobId, or a Cutover object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTCutover</maml:para> <maml:para>Returns all Cutovers.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTCutover -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10</maml:para> <maml:para>Returns the most recent 10 Cutovers for the specified User where IsComplete is true.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTCutover --> <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-BTCutover</command:name> <command:verb>Start</command:verb> <command:noun>BTCutover</command:noun> <maml:description> <maml:para>Start Cutover operations for Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTCutover -User starts a Cutover operation for a User.</maml:para> <maml:para>Start-BTCutover -Wave starts a Cutover operation for a Wave.</maml:para> <maml:para>Start-BTCutover -InputObject starts a Cutover operation for a User or Wave.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTCutover cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByUser --> <command:syntaxItem> <maml:name>Start-BTCutover</maml:name> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByWave --> <command:syntaxItem> <maml:name>Start-BTCutover</maml:name> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInputObject --> <command:syntaxItem> <maml:name>Start-BTCutover</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</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> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</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> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTCutover -User 356</maml:para> <maml:para>Start-BTCutover -User joe@contoso.com</maml:para> <maml:para>Start-BTCutover -User $user</maml:para> <maml:para>Starts a Cutover for a User by id, identity, or User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Start-BTCutover -Wave 356</maml:para> <maml:para>Start-BTCutover -Wave 'My Wave'</maml:para> <maml:para>Start-BTCutover -Wave $wave</maml:para> <maml:para>Starts a Cutover for a Wave by id, identity, or Wave object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>$usersOrWaves | Start-BTCutover</maml:para> <maml:para>Starts a Cutover for each input object, which can be a User or a Wave object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Submit-BTCutoverMessage --> <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>Submit-BTCutoverMessage</command:name> <command:verb>Submit</command:verb> <command:noun>BTCutoverMessage</command:noun> <maml:description> <maml:para>Submits Cutover messages for Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Submit-BTCutoverMessage -User submits a Cutover message for a User.</maml:para> <maml:para>Submit-BTCutoverMessage -InputObject submits a Cutover message for a User.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Submit-BTCutoverMessage cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByUser --> <command:syntaxItem> <maml:name>Submit-BTCutoverMessage</maml:name> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInputObject --> <command:syntaxItem> <maml:name>Submit-BTCutoverMessage</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</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> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The User object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Submit-BTCutoverMessage -User 356</maml:para> <maml:para>Submit-BTCutoverMessage -User joe@contoso.com</maml:para> <maml:para>Submit-BTCutoverMessage -User $user</maml:para> <maml:para>Submits a BTCutoverMessage for a User by id, identity, or User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>$users | Submit-BTCutoverMessage</maml:para> <maml:para>Submits a Cutover message for each input object, which can be a User object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDevice --> <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-BTDevice</command:name> <command:verb>Get</command:verb> <command:noun>BTDevice</command:noun> <maml:description> <maml:para>Returns the Devices.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDevice -Identity returns the Device identified by its DeviceId, identity, or a Device object.</maml:para> <maml:para>Get-BTDevice [-Filter] [-Limit] returns Devices matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDevice cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDevice</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Device identity: DeviceId, SAMAccountName, or a Device object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDevice</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "SAMAccountName -like 'My*'". The supported properties are DeviceId EnvironmentId, DirectoryObjectId, TargetEnvironmentId, SAMAccountName, ExternalDeviceId, ReACLProfileId, CredentialCacheProfileId, CutoverCredentialId, NetworkProfileId, MigrationProfileId, EntraIDJoinProfileId, AgentKey, ServiceKey, IsAgentRegistered, ReACLStatus, DiscoveryStatus, CutoverStatus, CleanupStatus, CredentialCacheStatus, OfflineDomainJoinStatus, EntraIDCutoverStatus, AgentVersion, OperatingSystemVersion, LastJobMessage, PollingIntervalSeconds, CachePollingIntervalSeconds, AgentLastContactTimestamp, MigrationWaveId and IsPendingRemoval.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Device identity: DeviceId, SAMAccountName, or a Device object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "SAMAccountName -like 'My*'". The supported properties are DeviceId EnvironmentId, DirectoryObjectId, TargetEnvironmentId, SAMAccountName, ExternalDeviceId, ReACLProfileId, CredentialCacheProfileId, CutoverCredentialId, NetworkProfileId, MigrationProfileId, EntraIDJoinProfileId, AgentKey, ServiceKey, IsAgentRegistered, ReACLStatus, DiscoveryStatus, CutoverStatus, CleanupStatus, CredentialCacheStatus, OfflineDomainJoinStatus, EntraIDCutoverStatus, AgentVersion, OperatingSystemVersion, LastJobMessage, PollingIntervalSeconds, CachePollingIntervalSeconds, AgentLastContactTimestamp, MigrationWaveId and IsPendingRemoval.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Device identity: DeviceId, SAMAccountName, or a Device object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Device --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Device</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-BTDevice -Identity 986</maml:para> <maml:para>Get-BTDevice -Identity 'My Device SAMAccountName'</maml:para> <maml:para>Get-BTDevice -Identity $Device</maml:para> <maml:para>Returns a Device by DeviceId, identity, or a Device object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDevice</maml:para> <maml:para>Returns all Devices.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDevice -Filter "SAMAccountName -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 Devices whose SAMAccountName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDevice --> <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-BTDevice</command:name> <command:verb>Set</command:verb> <command:noun>BTDevice</command:noun> <maml:description> <maml:para>Set new property values in a Device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDevice -Identity Device (by object or id) cmdlet sets properties in the specified Device.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDevice cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDevice</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Device identity: DeviceId or a Device object.</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> <!-- Parameter: ReACLProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReACLProfile</maml:name> <maml:description> <maml:para>ReACL Profile (object or id)</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> <!-- Parameter: TargetEnvironment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <maml:description> <maml:para>Target Environment (object or id)</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Device identity: DeviceId or a Device object.</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> <!-- Parameter: TargetEnvironment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <maml:description> <maml:para>Target Environment (object or id)</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> <!-- Parameter: ReACLProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReACLProfile</maml:name> <maml:description> <maml:para>ReACL Profile (object or id)</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Device identity: DeviceId or a Device object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Device --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Device</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-BTDevice -Identity 25 -TaskName "new value"</maml:para> <maml:para>Set a Device TaskName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceAction --> <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-BTDeviceAction</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceAction</command:noun> <maml:description> <maml:para>Returns the DeviceActions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceAction -Identity returns the DeviceAction identified by its DeviceActionId, identity, or a DeviceAction object.</maml:para> <maml:para>Get-BTDeviceAction [-Filter] [-Limit] returns DeviceActions matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceAction cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceAction</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceAction identity: DeviceActionId, ActionName, or a DeviceAction object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceAction</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "CmdletGenerator.Templates.SDKModelPropertyInfo -like 'My*'". The supported properties are DeviceActionId ActionName, ActionDisplayName, ActionType, ActionTarget and Description.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceAction identity: DeviceActionId, ActionName, or a DeviceAction object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "CmdletGenerator.Templates.SDKModelPropertyInfo -like 'My*'". The supported properties are DeviceActionId ActionName, ActionDisplayName, ActionType, ActionTarget and Description.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceAction identity: DeviceActionId, ActionName, or a DeviceAction object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceAction --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceAction</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-BTDeviceAction -Identity 986</maml:para> <maml:para>Get-BTDeviceAction -Identity 'My DeviceAction ActionName'</maml:para> <maml:para>Get-BTDeviceAction -Identity $DeviceAction</maml:para> <maml:para>Returns a DeviceAction by DeviceActionId, identity, or a DeviceAction object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceAction</maml:para> <maml:para>Returns all DeviceActions.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceAction -Filter "CmdletGenerator.Templates.SDKModelPropertyInfo -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceActions whose CmdletGenerator.Templates.SDKModelPropertyInfo starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceAction --> <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-BTDeviceAction</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceAction</command:noun> </command:details> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceAction</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceAction Identity (object). If specified, Identity object will be used to create the new DeviceAction and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceAction</maml:name> <!-- Parameter: ActionDisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionDisplayName</maml:name> <maml:description> <maml:para>Name that appears in the Actions Menu</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: ActionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionName</maml:name> <maml:description> <maml:para>DeviceAction 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: ActionTarget --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionTarget</maml:name> <maml:description> <maml:para>Target determines where the Action will appear in Device or File Share Action menu</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: ActionTasks --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionTasks</maml:name> <maml:description> <maml:para>DeviceAction Tasks</maml:para> </maml:description> <command:parameterValue required="true">ICollection`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.ICollection`1[[BinaryTree.Power365.SDK.DeviceActionTask, BinaryTree.Power365.SDK, Version=20.12.15.6019, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActionType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Type determines what validations are applicable to the job, and which status columns are updated when the job runs</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: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>DeviceAction Description</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceAction Identity (object). If specified, Identity object will be used to create the new DeviceAction and other parameters will be ignored.</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> <!-- Parameter: ActionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionName</maml:name> <maml:description> <maml:para>DeviceAction 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: ActionDisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionDisplayName</maml:name> <maml:description> <maml:para>Name that appears in the Actions Menu</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: ActionType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Type determines what validations are applicable to the job, and which status columns are updated when the job runs</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: ActionTarget --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionTarget</maml:name> <maml:description> <maml:para>Target determines where the Action will appear in Device or File Share Action menu</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: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>DeviceAction Description</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: ActionTasks --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionTasks</maml:name> <maml:description> <maml:para>DeviceAction Tasks</maml:para> </maml:description> <command:parameterValue required="true">ICollection`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.ICollection`1[[BinaryTree.Power365.SDK.DeviceActionTask, BinaryTree.Power365.SDK, Version=20.12.15.6019, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceAction Identity (object). If specified, Identity object will be used to create the new DeviceAction and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceAction --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceAction</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-BTDeviceAction --> <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-BTDeviceAction</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceAction</command:noun> <maml:description> <maml:para>Removes the DeviceActions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceAction -Identity DeviceAction(by object or id) cmdlet removes the specified DeviceAction.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceAction cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceAction</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceAction identity: DeviceActionId or a DeviceAction object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceAction identity: DeviceActionId or a DeviceAction object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceAction identity: DeviceActionId or a DeviceAction object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceAction -Identity 986</maml:para> <maml:para>Removes a DeviceAction.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceAction --> <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-BTDeviceAction</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceAction</command:noun> <maml:description> <maml:para>Set new property values in a DeviceAction.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceAction -Identity DeviceAction (by object or id) cmdlet sets properties in the specified DeviceAction.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceAction cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceAction</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceAction identity: DeviceActionId or a DeviceAction object.</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> <!-- Parameter: ActionDisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionDisplayName</maml:name> <maml:description> <maml:para>Name that appears in the Actions Menu</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: ActionName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionName</maml:name> <maml:description> <maml:para>DeviceAction 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: ActionTarget --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionTarget</maml:name> <maml:description> <maml:para>Target determines where the Action will appear in Device or File Share Action menu</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: ActionTasks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionTasks</maml:name> <maml:description> <maml:para>DeviceAction Tasks</maml:para> </maml:description> <command:parameterValue required="true">ICollection`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.ICollection`1[[BinaryTree.Power365.SDK.DeviceActionTask, BinaryTree.Power365.SDK, Version=20.12.15.6019, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Type determines what validations are applicable to the job, and which status columns are updated when the job runs</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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>DeviceAction Description</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceAction identity: DeviceActionId or a DeviceAction object.</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> <!-- Parameter: ActionName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionName</maml:name> <maml:description> <maml:para>DeviceAction 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: ActionDisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionDisplayName</maml:name> <maml:description> <maml:para>Name that appears in the Actions Menu</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: ActionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Type determines what validations are applicable to the job, and which status columns are updated when the job runs</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: ActionTarget --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionTarget</maml:name> <maml:description> <maml:para>Target determines where the Action will appear in Device or File Share Action menu</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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>DeviceAction Description</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: ActionTasks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionTasks</maml:name> <maml:description> <maml:para>DeviceAction Tasks</maml:para> </maml:description> <command:parameterValue required="true">ICollection`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.ICollection`1[[BinaryTree.Power365.SDK.DeviceActionTask, BinaryTree.Power365.SDK, Version=20.12.15.6019, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceAction identity: DeviceActionId or a DeviceAction object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceAction --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceAction</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-BTDeviceAction -Identity 25 -ActionName "new value"</maml:para> <maml:para>Set a DeviceAction ActionName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disable-BTDeviceAgentAutoUpgrade --> <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>Disable-BTDeviceAgentAutoUpgrade</command:name> <command:verb>Disable</command:verb> <command:noun>BTDeviceAgentAutoUpgrade</command:noun> <maml:description> <maml:para>Disable Device Agent auto upgrade.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-BTDeviceAgentAutoUpgrade</maml:name> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DeviceAgentConfig --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceAgentConfig</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Disable-BTDeviceAgentAutoUpgrade</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Enable-BTDeviceAgentAutoUpgrade --> <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>Enable-BTDeviceAgentAutoUpgrade</command:name> <command:verb>Enable</command:verb> <command:noun>BTDeviceAgentAutoUpgrade</command:noun> <maml:description> <maml:para>Enable Device Agent auto upgrade.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-BTDeviceAgentAutoUpgrade</maml:name> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DeviceAgentConfig --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceAgentConfig</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Enable-BTDeviceAgentAutoUpgrade</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceAgentConfig --> <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-BTDeviceAgentConfig</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceAgentConfig</command:noun> <maml:description> <maml:para>Returns the DeviceAgentConfig.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-BTDeviceAgentConfig</maml:name> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DeviceAgentConfig --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceAgentConfig</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-BTDeviceAgentConfig</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceCredential --> <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-BTDeviceCredential</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceCredential</command:noun> <maml:description> <maml:para>Returns the DeviceCredentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceCredential -Identity [-AsPlainText] returns the DeviceCredential identified by its DeviceCredentialId, identity, or a DeviceCredential object.</maml:para> <maml:para>Get-BTDeviceCredential [-Filter] [-Limit] [-AsPlainText] returns DeviceCredentials matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceCredential cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceCredential</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredential identity: DeviceCredentialId, CredentialName, or a DeviceCredential object.</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> <!-- Parameter: AsPlainText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Returns the DeviceCredential SourcePassword and TargetPassword as plain text</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceCredential</maml:name> <!-- Parameter: AsPlainText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Returns the DeviceCredential SourcePassword and TargetPassword as plain text</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "CredentialName -like 'My*'". The supported properties are DeviceCredentialId , CredentialName, CredentialType, SourceDomainName, SourceUserName, SourcePassword, TargetDomainName, TargetUserName and TargetPassword.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredential identity: DeviceCredentialId, CredentialName, or a DeviceCredential object.</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> <!-- Parameter: AsPlainText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Returns the DeviceCredential SourcePassword and TargetPassword as plain text</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "CredentialName -like 'My*'". The supported properties are DeviceCredentialId , CredentialName, CredentialType, SourceDomainName, SourceUserName, SourcePassword, TargetDomainName, TargetUserName and TargetPassword.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceCredential identity: DeviceCredentialId, CredentialName, or a DeviceCredential object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceCredential --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredential</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-BTDeviceCredential -Identity 986</maml:para> <maml:para>Get-BTDeviceCredential -Identity 'My DeviceCredential CredentialName'</maml:para> <maml:para>Get-BTDeviceCredential -Identity $DeviceCredential</maml:para> <maml:para>Returns a DeviceCredential by DeviceCredentialId, identity, or a DeviceCredential object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceCredential</maml:para> <maml:para>Returns all DeviceCredentials.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceCredential -Identity 986 -AsPlainText</maml:para> <maml:para>Returns the DeviceCredential with decrypted SourcePassword and TargetPassword.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceCredential -Filter "CredentialName -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceCredentials whose CredentialName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceCredential --> <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-BTDeviceCredential</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceCredential</command:noun> <maml:description> <maml:para>Create a new DeviceCredential.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-BTDeviceCredential -Identity DeviceCredential (by object) cmdlet creates the specified DeviceCredential.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-BTDeviceCredential cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceCredential</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredential Identity (object). If specified, Identity object will be used to create the new DeviceCredential and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceCredential</maml:name> <!-- Parameter: CredentialName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>DeviceCredential 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: CredentialType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>Credential Type</maml:para> <maml:para>Possible values: Cutover, EntraIDCutover</maml:para> </maml:description> <command:parameterValue required="true">DeviceCredentialType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredentialType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Cutover</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cutover</command:parameterValue> <command:parameterValue required="false" variableLength="false">EntraIDCutover</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IsSourceDeviceEntraIDJoined --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSourceDeviceEntraIDJoined</maml:name> <maml:description> <maml:para>true if source Device is EntraID joined</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceDomainName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceDomainName</maml:name> <maml:description> <maml:para>Source Domain 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: SourcePassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePassword</maml:name> <maml:description> <maml:para>Source Domain Password</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: SourceUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceUserName</maml:name> <maml:description> <maml:para>Source Domain UserName</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: TargetDomainName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDomainName</maml:name> <maml:description> <maml:para>Target Domain 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: TargetPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPassword</maml:name> <maml:description> <maml:para>Target Domain Password</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: TargetUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetUserName</maml:name> <maml:description> <maml:para>Target Domain UserName</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredential Identity (object). If specified, Identity object will be used to create the new DeviceCredential and other parameters will be ignored.</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> <!-- Parameter: CredentialName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>DeviceCredential 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: CredentialType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>Credential Type</maml:para> <maml:para>Possible values: Cutover, EntraIDCutover</maml:para> </maml:description> <command:parameterValue required="true">DeviceCredentialType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredentialType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Cutover</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cutover</command:parameterValue> <command:parameterValue required="false" variableLength="false">EntraIDCutover</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SourceDomainName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceDomainName</maml:name> <maml:description> <maml:para>Source Domain 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: SourceUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceUserName</maml:name> <maml:description> <maml:para>Source Domain UserName</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: SourcePassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePassword</maml:name> <maml:description> <maml:para>Source Domain Password</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: TargetDomainName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDomainName</maml:name> <maml:description> <maml:para>Target Domain 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: TargetUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetUserName</maml:name> <maml:description> <maml:para>Target Domain UserName</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: TargetPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPassword</maml:name> <maml:description> <maml:para>Target Domain Password</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: IsSourceDeviceEntraIDJoined --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSourceDeviceEntraIDJoined</maml:name> <maml:description> <maml:para>true if source Device is EntraID joined</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceCredential Identity (object). If specified, Identity object will be used to create the new DeviceCredential and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceCredential --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredential</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTDeviceCredential -CredentialName Name -CredentialType Cutover -SourceDomainName fabrikam.com -SourceUserName fabrikam\username -SourcePassword pass -TargetDomainName fabrikam.com -TargetUserName fabrikam\username -TargetPassword pass</maml:para> <maml:para>Creates a new DeviceCredential.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-BTDeviceCredential --> <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-BTDeviceCredential</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceCredential</command:noun> <maml:description> <maml:para>Removes the DeviceCredentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceCredential -Identity DeviceCredential(by object or id) cmdlet removes the specified DeviceCredential.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceCredential cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceCredential</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredential identity: DeviceCredentialId or a DeviceCredential object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredential identity: DeviceCredentialId or a DeviceCredential object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceCredential identity: DeviceCredentialId or a DeviceCredential object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceCredential -Identity 986</maml:para> <maml:para>Removes a DeviceCredential.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceCredential --> <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-BTDeviceCredential</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceCredential</command:noun> <maml:description> <maml:para>Set new property values in a DeviceCredential.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceCredential -Identity DeviceCredential (by object or id) cmdlet sets properties in the specified DeviceCredential.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceCredential cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceCredential</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredential identity: DeviceCredentialId or a DeviceCredential object.</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> <!-- Parameter: CredentialName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>DeviceCredential 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: CredentialType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>Credential Type</maml:para> <maml:para>Possible values: Cutover, EntraIDCutover</maml:para> </maml:description> <command:parameterValue required="true">DeviceCredentialType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredentialType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Cutover</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cutover</command:parameterValue> <command:parameterValue required="false" variableLength="false">EntraIDCutover</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IsSourceDeviceEntraIDJoined --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSourceDeviceEntraIDJoined</maml:name> <maml:description> <maml:para>true if source Device is EntraID joined</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceDomainName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceDomainName</maml:name> <maml:description> <maml:para>Source Domain 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: SourcePassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePassword</maml:name> <maml:description> <maml:para>Source Domain Password</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: SourceUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceUserName</maml:name> <maml:description> <maml:para>Source Domain UserName</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: TargetDomainName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDomainName</maml:name> <maml:description> <maml:para>Target Domain 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: TargetPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPassword</maml:name> <maml:description> <maml:para>Target Domain Password</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: TargetUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetUserName</maml:name> <maml:description> <maml:para>Target Domain UserName</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredential identity: DeviceCredentialId or a DeviceCredential object.</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> <!-- Parameter: CredentialName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>DeviceCredential 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: CredentialType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>Credential Type</maml:para> <maml:para>Possible values: Cutover, EntraIDCutover</maml:para> </maml:description> <command:parameterValue required="true">DeviceCredentialType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredentialType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Cutover</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cutover</command:parameterValue> <command:parameterValue required="false" variableLength="false">EntraIDCutover</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SourceDomainName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceDomainName</maml:name> <maml:description> <maml:para>Source Domain 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: SourceUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceUserName</maml:name> <maml:description> <maml:para>Source Domain UserName</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: SourcePassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePassword</maml:name> <maml:description> <maml:para>Source Domain Password</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: TargetDomainName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDomainName</maml:name> <maml:description> <maml:para>Target Domain 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: TargetUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetUserName</maml:name> <maml:description> <maml:para>Target Domain UserName</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: TargetPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPassword</maml:name> <maml:description> <maml:para>Target Domain Password</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: IsSourceDeviceEntraIDJoined --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSourceDeviceEntraIDJoined</maml:name> <maml:description> <maml:para>true if source Device is EntraID joined</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceCredential identity: DeviceCredentialId or a DeviceCredential object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceCredential --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredential</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-BTDeviceCredential -Identity 25 -CredentialName "new value"</maml:para> <maml:para>Set a DeviceCredential CredentialName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceCredentialCacheProfile --> <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-BTDeviceCredentialCacheProfile</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceCredentialCacheProfile</command:noun> <maml:description> <maml:para>Returns the DeviceCredentialCacheProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceCredentialCacheProfile -Identity returns the DeviceCredentialCacheProfile identified by its DeviceCredentialCacheProfileId, identity, or a DeviceCredentialCacheProfile object.</maml:para> <maml:para>Get-BTDeviceCredentialCacheProfile [-Filter] [-Limit] returns DeviceCredentialCacheProfiles matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceCredentialCacheProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceCredentialCacheProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile identity: DeviceCredentialCacheProfileId, ProfileName, or a DeviceCredentialCacheProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceCredentialCacheProfile</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceCredentialCacheProfileId ProfileName, TargetDCIPAddress, TargetDCPingInterval, TimeoutBeforeJobFailure and UserCredentialDialogTimeout.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile identity: DeviceCredentialCacheProfileId, ProfileName, or a DeviceCredentialCacheProfile object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceCredentialCacheProfileId ProfileName, TargetDCIPAddress, TargetDCPingInterval, TimeoutBeforeJobFailure and UserCredentialDialogTimeout.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceCredentialCacheProfile identity: DeviceCredentialCacheProfileId, ProfileName, or a DeviceCredentialCacheProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceCredentialCacheProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredentialCacheProfile</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-BTDeviceCredentialCacheProfile -Identity 986</maml:para> <maml:para>Get-BTDeviceCredentialCacheProfile -Identity 'My DeviceCredentialCacheProfile ProfileName'</maml:para> <maml:para>Get-BTDeviceCredentialCacheProfile -Identity $DeviceCredentialCacheProfile</maml:para> <maml:para>Returns a DeviceCredentialCacheProfile by DeviceCredentialCacheProfileId, identity, or a DeviceCredentialCacheProfile object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceCredentialCacheProfile</maml:para> <maml:para>Returns all DeviceCredentialCacheProfiles.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceCredentialCacheProfile -Filter "ProfileName -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceCredentialCacheProfiles whose ProfileName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceCredentialCacheProfile --> <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-BTDeviceCredentialCacheProfile</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceCredentialCacheProfile</command:noun> <maml:description> <maml:para>Create a new DeviceCredentialCacheProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-BTDeviceCredentialCacheProfile -Identity DeviceCredentialCacheProfile (by object) cmdlet creates the specified DeviceCredentialCacheProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-BTDeviceCredentialCacheProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceCredentialCacheProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile Identity (object). If specified, Identity object will be used to create the new DeviceCredentialCacheProfile and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceCredentialCacheProfile</maml:name> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile 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: TargetDCIPAddress --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDCIPAddress</maml:name> <maml:description> <maml:para>Target Domain Controller IP Address</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetDCPingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDCPingInterval</maml:name> <maml:description> <maml:para>Target Domain Controller ping interval in seconds</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>300</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutBeforeJobFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutBeforeJobFailure</maml:name> <maml:description> <maml:para>Timeout before job failure in minutes</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>180</dev:defaultValue> </command:parameter> <!-- Parameter: UserCredentialDialogTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserCredentialDialogTimeout</maml:name> <maml:description> <maml:para>Timeout for user credential prompt in minutes</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>5</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile Identity (object). If specified, Identity object will be used to create the new DeviceCredentialCacheProfile and other parameters will be ignored.</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> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile 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: TargetDCIPAddress --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDCIPAddress</maml:name> <maml:description> <maml:para>Target Domain Controller IP Address</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: TargetDCPingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDCPingInterval</maml:name> <maml:description> <maml:para>Target Domain Controller ping interval in seconds</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>300</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutBeforeJobFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutBeforeJobFailure</maml:name> <maml:description> <maml:para>Timeout before job failure in minutes</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>180</dev:defaultValue> </command:parameter> <!-- Parameter: UserCredentialDialogTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserCredentialDialogTimeout</maml:name> <maml:description> <maml:para>Timeout for user credential prompt in minutes</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>5</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceCredentialCacheProfile Identity (object). If specified, Identity object will be used to create the new DeviceCredentialCacheProfile and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceCredentialCacheProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredentialCacheProfile</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTDeviceCredentialCacheProfile -ProfileName Name -TargetDCIPAddress IpAddress</maml:para> <maml:para>Creates a new DeviceCredentialCacheProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-BTDeviceCredentialCacheProfile --> <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-BTDeviceCredentialCacheProfile</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceCredentialCacheProfile</command:noun> <maml:description> <maml:para>Removes the DeviceCredentialCacheProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceCredentialCacheProfile -Identity DeviceCredentialCacheProfile(by object or id) cmdlet removes the specified DeviceCredentialCacheProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceCredentialCacheProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceCredentialCacheProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile identity: DeviceCredentialCacheProfileId or a DeviceCredentialCacheProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile identity: DeviceCredentialCacheProfileId or a DeviceCredentialCacheProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceCredentialCacheProfile identity: DeviceCredentialCacheProfileId or a DeviceCredentialCacheProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceCredentialCacheProfile -Identity 986</maml:para> <maml:para>Removes a DeviceCredentialCacheProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceCredentialCacheProfile --> <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-BTDeviceCredentialCacheProfile</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceCredentialCacheProfile</command:noun> <maml:description> <maml:para>Set new property values in a DeviceCredentialCacheProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceCredentialCacheProfile -Identity DeviceCredentialCacheProfile (by object or id) cmdlet sets properties in the specified DeviceCredentialCacheProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceCredentialCacheProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceCredentialCacheProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile identity: DeviceCredentialCacheProfileId or a DeviceCredentialCacheProfile object.</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> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile 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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetDCIPAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDCIPAddress</maml:name> <maml:description> <maml:para>Target Domain Controller IP Address</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: TargetDCPingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDCPingInterval</maml:name> <maml:description> <maml:para>Target Domain Controller ping interval in seconds</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: TimeoutBeforeJobFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutBeforeJobFailure</maml:name> <maml:description> <maml:para>Timeout before job failure in minutes</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: UserCredentialDialogTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserCredentialDialogTimeout</maml:name> <maml:description> <maml:para>Timeout for user credential prompt in minutes</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile identity: DeviceCredentialCacheProfileId or a DeviceCredentialCacheProfile object.</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> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceCredentialCacheProfile 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: TargetDCIPAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDCIPAddress</maml:name> <maml:description> <maml:para>Target Domain Controller IP Address</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: TargetDCPingInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDCPingInterval</maml:name> <maml:description> <maml:para>Target Domain Controller ping interval in seconds</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: TimeoutBeforeJobFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutBeforeJobFailure</maml:name> <maml:description> <maml:para>Timeout before job failure in minutes</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: UserCredentialDialogTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserCredentialDialogTimeout</maml:name> <maml:description> <maml:para>Timeout for user credential prompt in minutes</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceCredentialCacheProfile identity: DeviceCredentialCacheProfileId or a DeviceCredentialCacheProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceCredentialCacheProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceCredentialCacheProfile</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-BTDeviceCredentialCacheProfile -Identity 25 -ProfileName "new value"</maml:para> <maml:para>Set a DeviceCredentialCacheProfile ProfileName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTDeviceCutover --> <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-BTDeviceCutover</command:name> <command:verb>Start</command:verb> <command:noun>BTDeviceCutover</command:noun> <maml:description> <maml:para>Start Device Cutover action.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTDeviceCutover -Device starts Cutover for a Device.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTDeviceCutover cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByDevice --> <command:syntaxItem> <maml:name>Start-BTDeviceCutover</maml:name> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Device identity: DeviceId, SamAccountName or Device object.</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> <!-- Parameter: CutoverCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CutoverCredential</maml:name> <maml:description> <maml:para>Cutover Credential (object or id)</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> <!-- Parameter: DoNotStartBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotStartBefore</maml:name> <maml:description> <maml:para>Do not start before time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreReACLStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreReACLStatus</maml:name> <maml:description> <maml:para>Ignore ReACL Status.</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: MigrationProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MigrationProfile</maml:name> <maml:description> <maml:para>Migration Profile (object or id)</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> <!-- Parameter: NetworkProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkProfile</maml:name> <maml:description> <maml:para>Network Profile (object or id)</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Device identity: DeviceId, SamAccountName or Device object.</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> <!-- Parameter: CutoverCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CutoverCredential</maml:name> <maml:description> <maml:para>Cutover Credential (object or id)</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> <!-- Parameter: MigrationProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MigrationProfile</maml:name> <maml:description> <maml:para>Migration Profile (object or id)</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> <!-- Parameter: NetworkProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkProfile</maml:name> <maml:description> <maml:para>Network Profile (object or id)</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> <!-- Parameter: IgnoreReACLStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreReACLStatus</maml:name> <maml:description> <maml:para>Ignore ReACL Status.</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: DoNotStartBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotStartBefore</maml:name> <maml:description> <maml:para>Do not start before time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</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>Start-BTDeviceCutover -Device 123</maml:para> <maml:para>Start-BTDeviceCutover -Device DeviceSamAccountName$</maml:para> <maml:para>Starts a Device Cutover action for a Device by id, identity, or device object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>$devices | Start-BTDeviceCutover</maml:para> <maml:para>Starts a Cutover action for each input Device object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceDataRepository --> <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-BTDeviceDataRepository</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceDataRepository</command:noun> <maml:description> <maml:para>Returns the Device DataRepositories.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceDataRepository -Identity returns the DataRepository identified by its DataRepositoryId, identity, or a DataRepository object.</maml:para> <maml:para>Get-BTDeviceDataRepository [-Filter] [-Limit] returns DataRepositories matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceDataRepository cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceDataRepository</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DataRepository identity: DataRepositoryId, DataRepositoryRole, or a DataRepository object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceDataRepository</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Path -like 'C:\path*'". The supported properties are DataRepositoryId and Path.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DataRepository identity: DataRepositoryId, DataRepositoryRole, or a DataRepository object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Path -like 'C:\path*'". The supported properties are DataRepositoryId and Path.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DataRepository identity: DataRepositoryId, DataRepositoryRole, or a DataRepository object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DataRepository --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DataRepository</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-BTDeviceDataRepository -Identity 986</maml:para> <maml:para>Get-BTDeviceDataRepository -Identity 'DataRepositoryRole'</maml:para> <maml:para>Get-BTDeviceDataRepository -Identity $dataRepository</maml:para> <maml:para>Returns a DataRepository by DataRepositoryId, identity, or a DataRepository object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceDataRepository</maml:para> <maml:para>Returns all DataRepositories.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceDataRepository -Filter "Path -like 'C:\*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DataRepositories whose Path starts with 'C:\'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceDataRepository --> <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-BTDeviceDataRepository</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceDataRepository</command:noun> <maml:description> <maml:para>Set new property values in a DataRepository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceDataRepository -Identity DataRepository (by object or id) cmdlet sets properties in the specified DataRepository.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceDataRepository cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceDataRepository</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DataRepository identity: DataRepositoryId, DataRepositoryRole or a DataRepository object.</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> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DataRepository identity: DataRepositoryId, DataRepositoryRole or a DataRepository object.</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> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DataRepository identity: DataRepositoryId, DataRepositoryRole or a DataRepository object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DataRepository --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DataRepository</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-BTDeviceDataRepository -Identity AgentLogs -Path "\\UNCPATH"</maml:para> <maml:para>Set a DataRepository path property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTDeviceEntraIDCutover --> <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-BTDeviceEntraIDCutover</command:name> <command:verb>Start</command:verb> <command:noun>BTDeviceEntraIDCutover</command:noun> <maml:description> <maml:para>Start Device Entra ID Cutover action.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTDeviceEntraIDCutover -Device starts Entra ID Cutover for a Device.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTDeviceEntraIDCutover cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByDevice --> <command:syntaxItem> <maml:name>Start-BTDeviceEntraIDCutover</maml:name> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Device identity: DeviceId, SamAccountName or Device object.</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> <!-- Parameter: EntraIDJoinProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntraIDJoinProfile</maml:name> <maml:description> <maml:para>Entra ID Join Profile (object or id)</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> <!-- Parameter: DoNotStartBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotStartBefore</maml:name> <maml:description> <maml:para>Do not start before time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreReACLStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreReACLStatus</maml:name> <maml:description> <maml:para>Ignore ReACL Status.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Device identity: DeviceId, SamAccountName or Device object.</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> <!-- Parameter: EntraIDJoinProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntraIDJoinProfile</maml:name> <maml:description> <maml:para>Entra ID Join Profile (object or id)</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> <!-- Parameter: IgnoreReACLStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreReACLStatus</maml:name> <maml:description> <maml:para>Ignore ReACL Status.</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: DoNotStartBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotStartBefore</maml:name> <maml:description> <maml:para>Do not start before time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</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>Start-BTDeviceEntraIDCutover -Device 123</maml:para> <maml:para>Start-BTDeviceEntraIDCutover -Device DeviceSamAccountName</maml:para> <maml:para>Starts a Device Cutover action for a Device by id, identity, or device object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>$devices | Start-BTDeviceEntraIDCutover</maml:para> <maml:para>Starts a Cutover action for each input Device object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceEntraIDJoinProfile --> <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-BTDeviceEntraIDJoinProfile</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceEntraIDJoinProfile</command:noun> <maml:description> <maml:para>Returns the DeviceEntraIDJoinProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceEntraIDJoinProfile -Identity returns the DeviceEntraIDJoinProfile identified by its DeviceEntraIDJoinProfileId, identity, or a DeviceEntraIDJoinProfile object.</maml:para> <maml:para>Get-BTDeviceEntraIDJoinProfile [-Filter] [-Limit] returns DeviceEntraIDJoinProfiles matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceEntraIDJoinProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceEntraIDJoinProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile identity: DeviceEntraIDJoinProfileId, ProfileName, or a DeviceEntraIDJoinProfile object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceEntraIDJoinProfile</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceEntraIDJoinProfileId, TargetEnvironmentId, ProfileName, PackageName, KeepDeviceName and SkipSourceADValidation.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile identity: DeviceEntraIDJoinProfileId, ProfileName, or a DeviceEntraIDJoinProfile object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceEntraIDJoinProfileId, TargetEnvironmentId, ProfileName, PackageName, KeepDeviceName and SkipSourceADValidation.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceEntraIDJoinProfile identity: DeviceEntraIDJoinProfileId, ProfileName, or a DeviceEntraIDJoinProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceEntraIDJoinProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceEntraIDJoinProfile</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-BTDeviceEntraIDJoinProfile -Identity 986</maml:para> <maml:para>Get-BTDeviceEntraIDJoinProfile -Identity 'My DeviceEntraIDJoinProfile ProfileName'</maml:para> <maml:para>Get-BTDeviceEntraIDJoinProfile -Identity $DeviceEntraIDJoinProfile</maml:para> <maml:para>Returns a DeviceEntraIDJoinProfile by DeviceEntraIDJoinProfileId, identity, or a DeviceEntraIDJoinProfile object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceEntraIDJoinProfile</maml:para> <maml:para>Returns all DeviceEntraIDJoinProfiles.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceEntraIDJoinProfile -Filter "ProfileName -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceEntraIDJoinProfiles whose ProfileName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceEntraIDJoinProfile --> <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-BTDeviceEntraIDJoinProfile</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceEntraIDJoinProfile</command:noun> <maml:description> <maml:para>Create a new DeviceEntraIDJoinProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-BTDeviceEntraIDJoinProfile -Identity DeviceEntraIDJoinProfile (by object) cmdlet creates the specified DeviceEntraIDJoinProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-BTDeviceEntraIDJoinProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceEntraIDJoinProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile Identity (object). If specified, Identity object will be used to create the new DeviceEntraIDJoinProfile and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceEntraIDJoinProfile</maml:name> <!-- Parameter: PackageName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Bulk enrollment package file 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: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile 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: TargetEnvironment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <maml:description> <maml:para>Target Environment (object or id)</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> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Source Domain Credential, will be created if not exists (object or id)</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> <!-- Parameter: KeepDeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepDeviceName</maml:name> <maml:description> <maml:para>Keep original device name when true, device name defined per provisioning package when false</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipSourceADValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSourceADValidation</maml:name> <maml:description> <maml:para>Skip source local Active Directory validation​</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile Identity (object). If specified, Identity object will be used to create the new DeviceEntraIDJoinProfile and other parameters will be ignored.</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> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Source Domain Credential, will be created if not exists (object or id)</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> <!-- Parameter: TargetEnvironment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <maml:description> <maml:para>Target Environment (object or id)</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> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile 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: PackageName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Bulk enrollment package file 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: KeepDeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepDeviceName</maml:name> <maml:description> <maml:para>Keep original device name when true, device name defined per provisioning package when false</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SkipSourceADValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSourceADValidation</maml:name> <maml:description> <maml:para>Skip source local Active Directory validation​</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceEntraIDJoinProfile Identity (object). If specified, Identity object will be used to create the new DeviceEntraIDJoinProfile and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceEntraIDJoinProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceEntraIDJoinProfile</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTDeviceEntraIDJoinProfile -ProfileName Name -TargetEnvironment $Environment -PackageName PackageName</maml:para> <maml:para>Creates a new DeviceEntraIDJoinProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-BTDeviceEntraIDJoinProfile --> <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-BTDeviceEntraIDJoinProfile</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceEntraIDJoinProfile</command:noun> <maml:description> <maml:para>Removes the DeviceEntraIDJoinProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceEntraIDJoinProfile -Identity DeviceEntraIDJoinProfile(by object or id) cmdlet removes the specified DeviceEntraIDJoinProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceEntraIDJoinProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceEntraIDJoinProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile identity: DeviceEntraIDJoinProfileId or a DeviceEntraIDJoinProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile identity: DeviceEntraIDJoinProfileId or a DeviceEntraIDJoinProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceEntraIDJoinProfile identity: DeviceEntraIDJoinProfileId or a DeviceEntraIDJoinProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceEntraIDJoinProfile -Identity 986</maml:para> <maml:para>Removes a DeviceEntraIDJoinProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceEntraIDJoinProfile --> <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-BTDeviceEntraIDJoinProfile</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceEntraIDJoinProfile</command:noun> <maml:description> <maml:para>Set new property values in a DeviceEntraIDJoinProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceEntraIDJoinProfile -Identity DeviceEntraIDJoinProfile (by object or id) cmdlet sets properties in the specified DeviceEntraIDJoinProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceEntraIDJoinProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceEntraIDJoinProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile identity: DeviceEntraIDJoinProfileId or a DeviceEntraIDJoinProfile object.</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> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Source Domain Credential, will be created if not exists (object or id)</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> <!-- Parameter: KeepDeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepDeviceName</maml:name> <maml:description> <maml:para>Keep original device name when true, device name defined per provisioning package when false</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PackageName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Bulk enrollment package file 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: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile 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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipSourceADValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSourceADValidation</maml:name> <maml:description> <maml:para>Skip source local Active Directory validation​</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile identity: DeviceEntraIDJoinProfileId or a DeviceEntraIDJoinProfile object.</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> <!-- Parameter: Credential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Source Domain Credential, will be created if not exists (object or id)</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> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceEntraIDJoinProfile 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: PackageName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Bulk enrollment package file 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: KeepDeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepDeviceName</maml:name> <maml:description> <maml:para>Keep original device name when true, device name defined per provisioning package when false</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SkipSourceADValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSourceADValidation</maml:name> <maml:description> <maml:para>Skip source local Active Directory validation​</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceEntraIDJoinProfile identity: DeviceEntraIDJoinProfileId or a DeviceEntraIDJoinProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceEntraIDJoinProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceEntraIDJoinProfile</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-BTDeviceEntraIDJoinProfile -Identity 25 -ProfileName "new value"</maml:para> <maml:para>Set a DeviceEntraIDJoinProfile ProfileName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceGlobalVariable --> <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-BTDeviceGlobalVariable</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceGlobalVariable</command:noun> <maml:description> <maml:para>Returns the DeviceGlobalVariables.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceGlobalVariable -Identity [-AsPlainText] returns the DeviceGlobalVariable identified by its DeviceGlobalVariableId, identity, or a DeviceGlobalVariable object.</maml:para> <maml:para>Get-BTDeviceGlobalVariable [-Filter] [-Limit] [-AsPlainText] returns DeviceGlobalVariables matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceGlobalVariable cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceGlobalVariable</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceGlobalVariable identity: DeviceGlobalVariableId, Name, or a DeviceGlobalVariable object.</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> <!-- Parameter: AsPlainText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Returns retrieve the DeviceGlobalVariable Value as plain text</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceGlobalVariable</maml:name> <!-- Parameter: AsPlainText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Returns retrieve the DeviceGlobalVariable Value as plain text</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are DeviceGlobalVariableId, Name and IsEncrypted.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceGlobalVariable identity: DeviceGlobalVariableId, Name, or a DeviceGlobalVariable object.</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> <!-- Parameter: AsPlainText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AsPlainText</maml:name> <maml:description> <maml:para>Returns retrieve the DeviceGlobalVariable Value as plain text</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are DeviceGlobalVariableId, Name and IsEncrypted.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceGlobalVariable identity: DeviceGlobalVariableId, Name, or a DeviceGlobalVariable object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceGlobalVariable --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceGlobalVariable</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-BTDeviceGlobalVariable -Identity 986</maml:para> <maml:para>Get-BTDeviceGlobalVariable -Identity 'My DeviceGlobalVariable Name'</maml:para> <maml:para>Get-BTDeviceGlobalVariable -Identity $DeviceGlobalVariable</maml:para> <maml:para>Returns a DeviceGlobalVariable by DeviceGlobalVariableId, identity, or a DeviceGlobalVariable object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceGlobalVariable -Identity 986 -AsPlainText</maml:para> <maml:para>Returns a DeviceGlobalVariable with decrypted Value.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceGlobalVariable</maml:para> <maml:para>Returns all DeviceGlobalVariables.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceGlobalVariable -Filter "Name -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceGlobalVariables whose Name starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceGlobalVariable --> <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-BTDeviceGlobalVariable</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceGlobalVariable</command:noun> <maml:description> <maml:para>Create a new DeviceGlobalVariable.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-BTDeviceGlobalVariable -Identity DeviceGlobalVariable (by object) cmdlet creates the specified DeviceGlobalVariable.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-BTDeviceGlobalVariable cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceGlobalVariable</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceGlobalVariable Identity (object). If specified, Identity object will be used to create the new DeviceGlobalVariable and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceGlobalVariable</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>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: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value</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: IsEncrypted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsEncrypted</maml:name> <maml:description> <maml:para>true if the DeviceGlobalVariable Value should be encrypted</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceGlobalVariable Identity (object). If specified, Identity object will be used to create the new DeviceGlobalVariable and other parameters will be ignored.</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> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>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: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value</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: IsEncrypted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsEncrypted</maml:name> <maml:description> <maml:para>true if the DeviceGlobalVariable Value should be encrypted</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceGlobalVariable Identity (object). If specified, Identity object will be used to create the new DeviceGlobalVariable and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceGlobalVariable --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceGlobalVariable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTDeviceGlobalVariable -Name "name" -Value "value"</maml:para> <maml:para>Creates a new DeviceGlobalVariable.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-BTDeviceGlobalVariable --> <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-BTDeviceGlobalVariable</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceGlobalVariable</command:noun> <maml:description> <maml:para>Removes the DeviceGlobalVariables.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceGlobalVariable -Identity DeviceGlobalVariable(by object or id) cmdlet removes the specified DeviceGlobalVariable.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceGlobalVariable cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceGlobalVariable</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceGlobalVariable identity: DeviceGlobalVariableId or a DeviceGlobalVariable object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceGlobalVariable identity: DeviceGlobalVariableId or a DeviceGlobalVariable object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceGlobalVariable identity: DeviceGlobalVariableId or a DeviceGlobalVariable object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceGlobalVariable -Identity 986</maml:para> <maml:para>Removes a DeviceGlobalVariable.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceGlobalVariable --> <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-BTDeviceGlobalVariable</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceGlobalVariable</command:noun> <maml:description> <maml:para>Set new property values in a DeviceGlobalVariable.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceGlobalVariable -Identity DeviceGlobalVariable (by object or id) cmdlet sets properties in the specified DeviceGlobalVariable.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceGlobalVariable cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceGlobalVariable</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceGlobalVariable identity: DeviceGlobalVariableId or a DeviceGlobalVariable object.</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> <!-- Parameter: IsEncrypted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsEncrypted</maml:name> <maml:description> <maml:para>true if the Value should be encrypted</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceGlobalVariable identity: DeviceGlobalVariableId or a DeviceGlobalVariable object.</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> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>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: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value</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: IsEncrypted --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsEncrypted</maml:name> <maml:description> <maml:para>true if the Value should be encrypted</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceGlobalVariable identity: DeviceGlobalVariableId or a DeviceGlobalVariable object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceGlobalVariable --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceGlobalVariable</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-BTDeviceGlobalVariable -Identity 25 -Value "value"</maml:para> <maml:para>Set a DeviceGlobalVariable Value property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceJob --> <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-BTDeviceJob</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceJob</command:noun> <maml:description> <maml:para>Returns the DeviceJobs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceJob -Identity returns the DeviceJob identified by its DeviceJobId or a DeviceJob object.</maml:para> <maml:para>Get-BTDeviceJob [-Filter] [-Limit] returns DeviceJobs matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceJob cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceJob</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceJob identity: DeviceJobId or a DeviceJob object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceJob</maml:name> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Filter by Device identity: DeviceId, SamAccountName or Device object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "CmdletGenerator.Templates.SDKModelPropertyInfo -like 'My*'". The supported properties are DeviceJobId DeviceId, DeviceFileShareId, QueuedTimestamp, DoNotStartBefore, JobType, ActionName, CommandName, Status, Message, RollbackStatus, RollbackMessage, TimeoutSeconds, RetryCount and CancelRequested.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceJob identity: DeviceJobId or a DeviceJob object.</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> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Filter by Device identity: DeviceId, SamAccountName or Device object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "CmdletGenerator.Templates.SDKModelPropertyInfo -like 'My*'". The supported properties are DeviceJobId DeviceId, DeviceFileShareId, QueuedTimestamp, DoNotStartBefore, JobType, ActionName, CommandName, Status, Message, RollbackStatus, RollbackMessage, TimeoutSeconds, RetryCount and CancelRequested.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceJob identity: DeviceJobId or a DeviceJob object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceJob --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceJob</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-BTDeviceJob -Identity 986</maml:para> <maml:para>Get-BTDeviceJob -Identity $DeviceJob</maml:para> <maml:para>Returns a DeviceJob by DeviceJobId, identity, or a DeviceJob object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceJob</maml:para> <maml:para>Returns all DeviceJobs.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceJob -Filter "CmdletGenerator.Templates.SDKModelPropertyInfo -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceJobs whose CmdletGenerator.Templates.SDKModelPropertyInfo starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceMigrationProfile --> <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-BTDeviceMigrationProfile</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceMigrationProfile</command:noun> <maml:description> <maml:para>Returns the DeviceMigrationProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceMigrationProfile -Identity returns the DeviceMigrationProfile identified by its DeviceMigrationProfileId, identity, or a DeviceMigrationProfile object.</maml:para> <maml:para>Get-BTDeviceMigrationProfile [-Filter] [-Limit] returns DeviceMigrationProfiles matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceMigrationProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceMigrationProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceMigrationProfile identity: DeviceMigrationProfileId, ProfileName, or a DeviceMigrationProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceMigrationProfile</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceMigrationProfileId , ProfileName, RebootDelay, DomainJoinDelay, EmptyRecycleBin, TargetOU, UseExistingComputerObject and PerformEntraIDJoin.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceMigrationProfile identity: DeviceMigrationProfileId, ProfileName, or a DeviceMigrationProfile object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceMigrationProfileId , ProfileName, RebootDelay, DomainJoinDelay, EmptyRecycleBin, TargetOU, UseExistingComputerObject and PerformEntraIDJoin.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceMigrationProfile identity: DeviceMigrationProfileId, ProfileName, or a DeviceMigrationProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceMigrationProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceMigrationProfile</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-BTDeviceMigrationProfile -Identity 986</maml:para> <maml:para>Get-BTDeviceMigrationProfile -Identity 'My DeviceMigrationProfile ProfileName'</maml:para> <maml:para>Get-BTDeviceMigrationProfile -Identity $DeviceMigrationProfile</maml:para> <maml:para>Returns a DeviceMigrationProfile by DeviceMigrationProfileId, identity, or a DeviceMigrationProfile object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceMigrationProfile</maml:para> <maml:para>Returns all DeviceMigrationProfiles.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceMigrationProfile -Filter "ProfileName -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceMigrationProfiles whose ProfileName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceMigrationProfile --> <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-BTDeviceMigrationProfile</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceMigrationProfile</command:noun> <maml:description> <maml:para>Create a new DeviceMigrationProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-BTDeviceMigrationProfile -Identity DeviceMigrationProfile (by object) cmdlet creates the specified DeviceMigrationProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-BTDeviceMigrationProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceMigrationProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceMigrationProfile Identity (object). If specified, Identity object will be used to create the new DeviceMigrationProfile and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceMigrationProfile</maml:name> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceMigrationProfile 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: DomainJoinDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainJoinDelay</maml:name> <maml:description> <maml:para>The delay time (in seconds) a 'Cutover' job (detected by the Device Agent) applies, before attempting to change the computer's domain.</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: EmptyRecycleBin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmptyRecycleBin</maml:name> <maml:description> <maml:para>Whether to empty the Recycle Bin prior to changing the computer's domain to avoid the possibility of Recycle Bin becoming corrupted.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: PerformEntraIDHybridLeaveAndJoin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PerformEntraIDHybridLeaveAndJoin</maml:name> <maml:description> <maml:para>Whether to join AD DS domain-joined computers to Entra ID by doing hybrid Entra ID join, or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RebootDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RebootDelay</maml:name> <maml:description> <maml:para>If specified (in seconds), a dialog box will appear for any logged-in users to notify them that the computer will be rebooted in the specified period of time. Otherwise the computer will reboot immediately after a successful domain change.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetOU --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetOU</maml:name> <maml:description> <maml:para>Full path (distinguished name) of the container or OU in the target domain in which the computer's account should be created. If blank, the computer account will be created in the default Computers container.</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: UseExistingComputerObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseExistingComputerObject</maml:name> <maml:description> <maml:para>If a computer account is found in the target domain with a matching name, that account's password will be reset and will be used for the computer 'Cutover'.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceMigrationProfile Identity (object). If specified, Identity object will be used to create the new DeviceMigrationProfile and other parameters will be ignored.</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> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceMigrationProfile 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: RebootDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RebootDelay</maml:name> <maml:description> <maml:para>If specified (in seconds), a dialog box will appear for any logged-in users to notify them that the computer will be rebooted in the specified period of time. Otherwise the computer will reboot immediately after a successful domain change.</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: DomainJoinDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainJoinDelay</maml:name> <maml:description> <maml:para>The delay time (in seconds) a 'Cutover' job (detected by the Device Agent) applies, before attempting to change the computer's domain.</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: EmptyRecycleBin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmptyRecycleBin</maml:name> <maml:description> <maml:para>Whether to empty the Recycle Bin prior to changing the computer's domain to avoid the possibility of Recycle Bin becoming corrupted.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: TargetOU --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetOU</maml:name> <maml:description> <maml:para>Full path (distinguished name) of the container or OU in the target domain in which the computer's account should be created. If blank, the computer account will be created in the default Computers container.</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: UseExistingComputerObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseExistingComputerObject</maml:name> <maml:description> <maml:para>If a computer account is found in the target domain with a matching name, that account's password will be reset and will be used for the computer 'Cutover'.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PerformEntraIDHybridLeaveAndJoin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PerformEntraIDHybridLeaveAndJoin</maml:name> <maml:description> <maml:para>Whether to join AD DS domain-joined computers to Entra ID by doing hybrid Entra ID join, or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceMigrationProfile Identity (object). If specified, Identity object will be used to create the new DeviceMigrationProfile and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceMigrationProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceMigrationProfile</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTDeviceMigrationProfile -ProfileName Name</maml:para> <maml:para>Creates a new DeviceMigrationProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-BTDeviceMigrationProfile --> <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-BTDeviceMigrationProfile</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceMigrationProfile</command:noun> <maml:description> <maml:para>Removes the DeviceMigrationProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceMigrationProfile -Identity DeviceMigrationProfile(by object or id) cmdlet removes the specified DeviceMigrationProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceMigrationProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceMigrationProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceMigrationProfile identity: DeviceMigrationProfileId or a DeviceMigrationProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceMigrationProfile identity: DeviceMigrationProfileId or a DeviceMigrationProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceMigrationProfile identity: DeviceMigrationProfileId or a DeviceMigrationProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceMigrationProfile -Identity 986</maml:para> <maml:para>Removes a DeviceMigrationProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceMigrationProfile --> <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-BTDeviceMigrationProfile</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceMigrationProfile</command:noun> <maml:description> <maml:para>Set new property values in a DeviceMigrationProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceMigrationProfile -Identity DeviceMigrationProfile (by object or id) cmdlet sets properties in the specified DeviceMigrationProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceMigrationProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceMigrationProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceMigrationProfile identity: DeviceMigrationProfileId or a DeviceMigrationProfile object.</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> <!-- Parameter: DomainJoinDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainJoinDelay</maml:name> <maml:description> <maml:para>The delay time (in seconds) a 'Cutover' job (detected by the Device Agent) applies, before attempting to change the computer's domain.</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: EmptyRecycleBin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmptyRecycleBin</maml:name> <maml:description> <maml:para>Whether to empty the Recycle Bin prior to changing the computer's domain to avoid the possibility of Recycle Bin becoming corrupted.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PerformEntraIDHybridLeaveAndJoin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PerformEntraIDHybridLeaveAndJoin</maml:name> <maml:description> <maml:para>Whether to join AD DS domain-joined computers to Entra AD by doing hybrid Entra AD join, or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceMigrationProfile 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: RebootDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RebootDelay</maml:name> <maml:description> <maml:para>If specified (in seconds), a dialog box will appear for any logged-in users to notify them that the computer will be rebooted in the specified period of time. Otherwise the computer will reboot immediately after a successful domain change.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetOU --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetOU</maml:name> <maml:description> <maml:para>Full path (distinguished name) of the container or OU in the target domain in which the computer's account should be created. If blank, the computer account will be created in the default Computers container.</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: UseExistingComputerObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseExistingComputerObject</maml:name> <maml:description> <maml:para>If a computer account is found in the target domain with a matching name, that account's password will be reset and will be used for the computer 'Cutover'.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceMigrationProfile identity: DeviceMigrationProfileId or a DeviceMigrationProfile object.</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> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceMigrationProfile 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: RebootDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RebootDelay</maml:name> <maml:description> <maml:para>If specified (in seconds), a dialog box will appear for any logged-in users to notify them that the computer will be rebooted in the specified period of time. Otherwise the computer will reboot immediately after a successful domain change.</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: DomainJoinDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainJoinDelay</maml:name> <maml:description> <maml:para>The delay time (in seconds) a 'Cutover' job (detected by the Device Agent) applies, before attempting to change the computer's domain.</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: EmptyRecycleBin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmptyRecycleBin</maml:name> <maml:description> <maml:para>Whether to empty the Recycle Bin prior to changing the computer's domain to avoid the possibility of Recycle Bin becoming corrupted.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TargetOU --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetOU</maml:name> <maml:description> <maml:para>Full path (distinguished name) of the container or OU in the target domain in which the computer's account should be created. If blank, the computer account will be created in the default Computers container.</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: UseExistingComputerObject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseExistingComputerObject</maml:name> <maml:description> <maml:para>If a computer account is found in the target domain with a matching name, that account's password will be reset and will be used for the computer 'Cutover'.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PerformEntraIDHybridLeaveAndJoin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PerformEntraIDHybridLeaveAndJoin</maml:name> <maml:description> <maml:para>Whether to join AD DS domain-joined computers to Entra AD by doing hybrid Entra AD join, or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceMigrationProfile identity: DeviceMigrationProfileId or a DeviceMigrationProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceMigrationProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceMigrationProfile</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-BTDeviceMigrationProfile -Identity 25 -ProfileName "new value"</maml:para> <maml:para>Set a DeviceMigrationProfile ProfileName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceNetworkProfile --> <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-BTDeviceNetworkProfile</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceNetworkProfile</command:noun> <maml:description> <maml:para>Returns the DeviceNetworkProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceNetworkProfile -Identity returns the DeviceNetworkProfile identified by its DeviceNetworkProfileId, identity, or a DeviceNetworkProfile object.</maml:para> <maml:para>Get-BTDeviceNetworkProfile [-Filter] [-Limit] returns DeviceNetworkProfiles matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceNetworkProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceNetworkProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceNetworkProfile identity: DeviceNetworkProfileId, ProfileName, or a DeviceNetworkProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceNetworkProfile</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceNetworkProfileId, ProfileName, UseDHCPForDNS, PrimaryDNS, SecondaryDNS, NicDNSSuffix, AppendDNSSuffix, RegWithDNSServer, UseNicDNSSuffix, PrimaryWINS and SecondaryWINS.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceNetworkProfile identity: DeviceNetworkProfileId, ProfileName, or a DeviceNetworkProfile object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceNetworkProfileId, ProfileName, UseDHCPForDNS, PrimaryDNS, SecondaryDNS, NicDNSSuffix, AppendDNSSuffix, RegWithDNSServer, UseNicDNSSuffix, PrimaryWINS and SecondaryWINS.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceNetworkProfile identity: DeviceNetworkProfileId, ProfileName, or a DeviceNetworkProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceNetworkProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceNetworkProfile</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-BTDeviceNetworkProfile -Identity 986</maml:para> <maml:para>Get-BTDeviceNetworkProfile -Identity 'My DeviceNetworkProfile ProfileName'</maml:para> <maml:para>Get-BTDeviceNetworkProfile -Identity $DeviceNetworkProfile</maml:para> <maml:para>Returns a DeviceNetworkProfile by DeviceNetworkProfileId, identity, or a DeviceNetworkProfile object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceNetworkProfile</maml:para> <maml:para>Returns all DeviceNetworkProfiles.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceNetworkProfile -Filter "ProfileName -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceNetworkProfiles whose ProfileName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceNetworkProfile --> <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-BTDeviceNetworkProfile</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceNetworkProfile</command:noun> <maml:description> <maml:para>Create a new DeviceNetworkProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-BTDeviceNetworkProfile -Identity DeviceNetworkProfile (by object) cmdlet creates the specified DeviceNetworkProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-BTDeviceNetworkProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceNetworkProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceNetworkProfile Identity (object). If specified, Identity object will be used to create the new DeviceNetworkProfile and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceNetworkProfile</maml:name> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceNetworkProfile 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: AppendDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppendDNSSuffix</maml:name> <maml:description> <maml:para>Preserve current DNS suffixes from the network adapter, null means 'Don't Change This Setting'</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: NicDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NicDNSSuffix</maml:name> <maml:description> <maml:para>The primary DNS suffix that will be set on the network adapter that is connected to the target domain. If blank, the default DNS suffix will be used for the target domain.</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: PrimaryDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryDNS</maml:name> <maml:description> <maml:para>Primary DNS 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: PrimaryDNSSuffixes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryDNSSuffixes</maml:name> <maml:description> <maml:para>Primary DNS suffixes</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: PrimaryWINS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryWINS</maml:name> <maml:description> <maml:para>Primary WINS 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: RegWithDNSServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegWithDNSServer</maml:name> <maml:description> <maml:para>Register the network adapter's addresses in DNS, null means 'Don't Change This Setting'</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: SecondaryDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryDNS</maml:name> <maml:description> <maml:para>Secondary DNS 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: SecondaryWINS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryWINS</maml:name> <maml:description> <maml:para>Secondary WINS 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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseDHCPForDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDHCPForDNS</maml:name> <maml:description> <maml:para>Use DHCP for DNS servers, null means 'Don't Change This Setting'</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: UseNicDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseNicDNSSuffix</maml:name> <maml:description> <maml:para>Include the network adapter's DNS suffix in the DNS registration</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceNetworkProfile Identity (object). If specified, Identity object will be used to create the new DeviceNetworkProfile and other parameters will be ignored.</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> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceNetworkProfile 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: UseDHCPForDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDHCPForDNS</maml:name> <maml:description> <maml:para>Use DHCP for DNS servers, null means 'Don't Change This Setting'</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: PrimaryDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryDNS</maml:name> <maml:description> <maml:para>Primary DNS 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: SecondaryDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryDNS</maml:name> <maml:description> <maml:para>Secondary DNS 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: NicDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NicDNSSuffix</maml:name> <maml:description> <maml:para>The primary DNS suffix that will be set on the network adapter that is connected to the target domain. If blank, the default DNS suffix will be used for the target domain.</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: AppendDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppendDNSSuffix</maml:name> <maml:description> <maml:para>Preserve current DNS suffixes from the network adapter, null means 'Don't Change This Setting'</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: PrimaryDNSSuffixes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryDNSSuffixes</maml:name> <maml:description> <maml:para>Primary DNS suffixes</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: RegWithDNSServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegWithDNSServer</maml:name> <maml:description> <maml:para>Register the network adapter's addresses in DNS, null means 'Don't Change This Setting'</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: UseNicDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseNicDNSSuffix</maml:name> <maml:description> <maml:para>Include the network adapter's DNS suffix in the DNS registration</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: PrimaryWINS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryWINS</maml:name> <maml:description> <maml:para>Primary WINS 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: SecondaryWINS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryWINS</maml:name> <maml:description> <maml:para>Secondary WINS 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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceNetworkProfile Identity (object). If specified, Identity object will be used to create the new DeviceNetworkProfile and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceNetworkProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceNetworkProfile</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTDeviceNetworkProfile -ProfileName Name</maml:para> <maml:para>Creates a new DeviceNetworkProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-BTDeviceNetworkProfile --> <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-BTDeviceNetworkProfile</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceNetworkProfile</command:noun> <maml:description> <maml:para>Removes the DeviceNetworkProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceNetworkProfile -Identity DeviceNetworkProfile(by object or id) cmdlet removes the specified DeviceNetworkProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceNetworkProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceNetworkProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceNetworkProfile identity: DeviceNetworkProfileId or a DeviceNetworkProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceNetworkProfile identity: DeviceNetworkProfileId or a DeviceNetworkProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceNetworkProfile identity: DeviceNetworkProfileId or a DeviceNetworkProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceNetworkProfile -Identity 986</maml:para> <maml:para>Removes a DeviceNetworkProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceNetworkProfile --> <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-BTDeviceNetworkProfile</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceNetworkProfile</command:noun> <maml:description> <maml:para>Set new property values in a DeviceNetworkProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceNetworkProfile -Identity DeviceNetworkProfile (by object or id) cmdlet sets properties in the specified DeviceNetworkProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceNetworkProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceNetworkProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceNetworkProfile identity: DeviceNetworkProfileId or a DeviceNetworkProfile object.</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> <!-- Parameter: AppendDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppendDNSSuffix</maml:name> <maml:description> <maml:para>Preserve current DNS suffixes from the network adapter, null means 'Don't Change This Setting'</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: NicDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NicDNSSuffix</maml:name> <maml:description> <maml:para>The primary DNS suffix that will be set on the network adapter that is connected to the target domain. If blank, the default DNS suffix will be used for the target domain.</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: PrimaryDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryDNS</maml:name> <maml:description> <maml:para>Primary DNS 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: PrimaryDNSSuffixes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryDNSSuffixes</maml:name> <maml:description> <maml:para>Primary DNS suffixes</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: PrimaryWINS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryWINS</maml:name> <maml:description> <maml:para>Primary WINS 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: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceNetworkProfile 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: RegWithDNSServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegWithDNSServer</maml:name> <maml:description> <maml:para>Register the network adapter's addresses in DNS, null means 'Don't Change This Setting'</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: SecondaryDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryDNS</maml:name> <maml:description> <maml:para>Secondary DNS 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: SecondaryWINS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryWINS</maml:name> <maml:description> <maml:para>Secondary WINS 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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseDHCPForDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDHCPForDNS</maml:name> <maml:description> <maml:para>Use DHCP for DNS servers, null means 'Don't Change This Setting'</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: UseNicDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseNicDNSSuffix</maml:name> <maml:description> <maml:para>Include the network adapter's DNS suffix in the DNS registration</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceNetworkProfile identity: DeviceNetworkProfileId or a DeviceNetworkProfile object.</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> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceNetworkProfile 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: UseDHCPForDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDHCPForDNS</maml:name> <maml:description> <maml:para>Use DHCP for DNS servers, null means 'Don't Change This Setting'</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: PrimaryDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryDNS</maml:name> <maml:description> <maml:para>Primary DNS 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: SecondaryDNS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryDNS</maml:name> <maml:description> <maml:para>Secondary DNS 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: NicDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NicDNSSuffix</maml:name> <maml:description> <maml:para>The primary DNS suffix that will be set on the network adapter that is connected to the target domain. If blank, the default DNS suffix will be used for the target domain.</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: AppendDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppendDNSSuffix</maml:name> <maml:description> <maml:para>Preserve current DNS suffixes from the network adapter, null means 'Don't Change This Setting'</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: PrimaryDNSSuffixes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryDNSSuffixes</maml:name> <maml:description> <maml:para>Primary DNS suffixes</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: RegWithDNSServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegWithDNSServer</maml:name> <maml:description> <maml:para>Register the network adapter's addresses in DNS, null means 'Don't Change This Setting'</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: UseNicDNSSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseNicDNSSuffix</maml:name> <maml:description> <maml:para>Include the network adapter's DNS suffix in the DNS registration</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: PrimaryWINS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryWINS</maml:name> <maml:description> <maml:para>Primary WINS 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: SecondaryWINS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryWINS</maml:name> <maml:description> <maml:para>Secondary WINS 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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceNetworkProfile identity: DeviceNetworkProfileId or a DeviceNetworkProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceNetworkProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceNetworkProfile</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-BTDeviceNetworkProfile -Identity 25 -ProfileName "new value"</maml:para> <maml:para>Set a DeviceNetworkProfile ProfileName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTDeviceReACL --> <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-BTDeviceReACL</command:name> <command:verb>Start</command:verb> <command:noun>BTDeviceReACL</command:noun> <maml:description> <maml:para>Start Device ReACL action.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTDeviceReACL -Device starts ReACL for a Device.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTDeviceReACL cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByDevice --> <command:syntaxItem> <maml:name>Start-BTDeviceReACL</maml:name> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Device identity: DeviceId, SamAccountName or Device object.</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> <!-- Parameter: DoNotStartBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotStartBefore</maml:name> <maml:description> <maml:para>Do not start before time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Device identity: DeviceId, SamAccountName or Device object.</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> <!-- Parameter: DoNotStartBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotStartBefore</maml:name> <maml:description> <maml:para>Do not start before time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</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>Start-BTDeviceReACL -Device 123</maml:para> <maml:para>Start-BTDeviceReACL -Device DeviceSamAccountName$</maml:para> <maml:para>Starts a Device ReACL action for a Device by id, identity, or device object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>$devices | Start-BTDeviceReACL</maml:para> <maml:para>Starts a ReACL action for each input Device object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceReACLProfile --> <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-BTDeviceReACLProfile</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceReACLProfile</command:noun> <maml:description> <maml:para>Returns the DeviceReACLProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceReACLProfile -Identity returns the DeviceReACLProfile identified by its DeviceReACLProfileId, identity, or a DeviceReACLProfile object.</maml:para> <maml:para>Get-BTDeviceReACLProfile [-Filter] [-Limit] returns DeviceReACLProfiles matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceReACLProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceReACLProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceReACLProfile identity: DeviceReACLProfileId, ProfileName, or a DeviceReACLProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceReACLProfile</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WhatIf -eq $true". The supported properties are ProfileName, WhatIf, UpdateUserProfiles, UpdateRightsAssignments, UpdateLocalGroups, UpdatePrinterShares, UpdateDirectoryShares, UpdatePrinters, UpdateServices, UpdateServiceAccounts, UpdateRegistry, UpdateLocalFolders, UpdateFiles, UpdateSystemAcls, UpdateRoamingProfiles, PreserveArchiveBit, ElevateFailureAction, InvalidTargetProfileAction, LoggingLevel, CustomAceUsage</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceReACLProfile identity: DeviceReACLProfileId, ProfileName, or a DeviceReACLProfile object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WhatIf -eq $true". The supported properties are ProfileName, WhatIf, UpdateUserProfiles, UpdateRightsAssignments, UpdateLocalGroups, UpdatePrinterShares, UpdateDirectoryShares, UpdatePrinters, UpdateServices, UpdateServiceAccounts, UpdateRegistry, UpdateLocalFolders, UpdateFiles, UpdateSystemAcls, UpdateRoamingProfiles, PreserveArchiveBit, ElevateFailureAction, InvalidTargetProfileAction, LoggingLevel, CustomAceUsage</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceReACLProfile identity: DeviceReACLProfileId, ProfileName, or a DeviceReACLProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceReACLProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceReACLProfile</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-BTDeviceReACLProfile -Identity 986</maml:para> <maml:para>Get-BTDeviceReACLProfile -Identity 'My DeviceReACLProfile Name'</maml:para> <maml:para>Get-BTDeviceReACLProfile -Identity $DeviceReACLProfile</maml:para> <maml:para>Returns a DeviceReACLProfile by DeviceReACLProfileId, identity, or a DeviceReACLProfile object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceReACLProfile</maml:para> <maml:para>Returns all DeviceReACLProfiles.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceReACLProfile -Filter "ProfileName -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceReACLProfiles whose ProfileName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceReACLProfile --> <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-BTDeviceReACLProfile</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceReACLProfile</command:noun> <maml:description> <maml:para>Create a new DeviceReACLProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-BTDeviceReACLProfile -Identity DeviceReACLProfile (by object) cmdlet creates the specified DeviceReACLProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-BTDeviceReACLProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceReACLProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceReACLProfile Identity (object). If specified, Identity object will be used to create the new DeviceReACLProfile and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceReACLProfile</maml:name> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceReACLProfile 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: CustomAceUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomAceUsage</maml:name> <maml:description> <maml:para>If preserved, file and folder permissions are updated by adding the target security principals and keeping the source security principals; otherwise, the source security principals are removed from the permissions</maml:para> <maml:para>Possible values: Never, IfAmbiguous, Always</maml:para> </maml:description> <command:parameterValue required="true">CustomAceUsage</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CustomAceUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Always</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" variableLength="false">IfAmbiguous</command:parameterValue> <command:parameterValue required="false" variableLength="false">Always</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ElevateFailureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElevateFailureAction</maml:name> <maml:description> <maml:para>Action when Agent is unable to generate a security token with elevated permissions</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeFiles</maml:name> <maml:description> <maml:para>Excluded Files from processing</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: ExcludePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePaths</maml:name> <maml:description> <maml:para>Excluded paths from processing</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\Windows, \WINNT, \I386, \Windows\I386, \Program Files, \PROGRAM FILES (x86), \MSOCACHE, \System Volume Information, \Recycler, \$RECYCLE.BIN, \CONFIG.MSI, \RECOVERY, \OEM, \Quarantine, \BOOT, \ProgramData\Microsoft\Windows Defender</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeRegistryKeys --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRegistryKeys</maml:name> <maml:description> <maml:para>Excluded Registry Keys from processing</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: ExcludeSecurityIdentifiers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSecurityIdentifiers</maml:name> <maml:description> <maml:para>Excluded Security Identifiers from processing</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: InvalidTargetProfileAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InvalidTargetProfileAction</maml:name> <maml:description> <maml:para>Action when an invalid or duplicate profile exists in the target</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LocalFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalFolders</maml:name> <maml:description> <maml:para>Only specified Local Folders and their subfolders to be processed</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: LoggingLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoggingLevel</maml:name> <maml:description> <maml:para>General Logging Level</maml:para> <maml:para>Possible values: Info, Debug</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevelGeneral</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevelGeneral</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Info</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: PreserveArchiveBit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveArchiveBit</maml:name> <maml:description> <maml:para>Preserve Archive Bit</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReparsePointRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReparsePointRules</maml:name> <maml:description> <maml:para>Reparse Tags that change how ReACL will process Reparse Points like Symbolic Links, Mount Points, and OneDrive</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0xA0000003:Update, 0xA000000C:Update, 0x9000001A:Full, 0x9000101A:Full, 0x9000201A:Full, 0x9000301A:Full, 0x9000401A:Full, 0x9000501A:Full, 0x9000601A:Full, 0x9000701A:Full, 0x9000801A:Full, 0x9000901A:Full, 0x9000A01A:Full, 0x9000B01A:Full, 0x9000C01A:Full, 0x9000D01A:Full, 0x9000E01A:Full, 0x9000F01A:Full</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateDirectoryShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateDirectoryShares</maml:name> <maml:description> <maml:para>Update Directory Shares</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateFiles</maml:name> <maml:description> <maml:para>Update Files</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLocalFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLocalFolders</maml:name> <maml:description> <maml:para>Update Local Folders</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLocalGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLocalGroups</maml:name> <maml:description> <maml:para>Update Local Groups</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatePrinters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatePrinters</maml:name> <maml:description> <maml:para>Update Printers</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatePrinterShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatePrinterShares</maml:name> <maml:description> <maml:para>Update Printer Shares</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRegistry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRegistry</maml:name> <maml:description> <maml:para>Update Registry</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRightsAssignments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRightsAssignments</maml:name> <maml:description> <maml:para>Update Rights Assignments</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRoamingProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRoamingProfiles</maml:name> <maml:description> <maml:para>Update Roaming Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServiceAccounts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateServiceAccounts</maml:name> <maml:description> <maml:para>Update Service Accounts</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServices --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateServices</maml:name> <maml:description> <maml:para>Update Services</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateSystemAcls --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateSystemAcls</maml:name> <maml:description> <maml:para>Update System Acls</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateUserProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateUserProfiles</maml:name> <maml:description> <maml:para>Update User Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: WhatIf --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Whether DeviceReACLProfile runs processing in simulation only</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceReACLProfile Identity (object). If specified, Identity object will be used to create the new DeviceReACLProfile and other parameters will be ignored.</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> <!-- Parameter: WhatIf --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Whether DeviceReACLProfile runs processing in simulation only</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateUserProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateUserProfiles</maml:name> <maml:description> <maml:para>Update User Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRightsAssignments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRightsAssignments</maml:name> <maml:description> <maml:para>Update Rights Assignments</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLocalGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLocalGroups</maml:name> <maml:description> <maml:para>Update Local Groups</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatePrinterShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatePrinterShares</maml:name> <maml:description> <maml:para>Update Printer Shares</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateDirectoryShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateDirectoryShares</maml:name> <maml:description> <maml:para>Update Directory Shares</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatePrinters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatePrinters</maml:name> <maml:description> <maml:para>Update Printers</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServices --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateServices</maml:name> <maml:description> <maml:para>Update Services</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServiceAccounts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateServiceAccounts</maml:name> <maml:description> <maml:para>Update Service Accounts</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRegistry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRegistry</maml:name> <maml:description> <maml:para>Update Registry</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLocalFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLocalFolders</maml:name> <maml:description> <maml:para>Update Local Folders</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateFiles</maml:name> <maml:description> <maml:para>Update Files</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateSystemAcls --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateSystemAcls</maml:name> <maml:description> <maml:para>Update System Acls</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRoamingProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRoamingProfiles</maml:name> <maml:description> <maml:para>Update Roaming Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveArchiveBit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveArchiveBit</maml:name> <maml:description> <maml:para>Preserve Archive Bit</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceReACLProfile 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: LocalFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalFolders</maml:name> <maml:description> <maml:para>Only specified Local Folders and their subfolders to be processed</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: ExcludePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePaths</maml:name> <maml:description> <maml:para>Excluded paths from processing</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\Windows, \WINNT, \I386, \Windows\I386, \Program Files, \PROGRAM FILES (x86), \MSOCACHE, \System Volume Information, \Recycler, \$RECYCLE.BIN, \CONFIG.MSI, \RECOVERY, \OEM, \Quarantine, \BOOT, \ProgramData\Microsoft\Windows Defender</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeRegistryKeys --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRegistryKeys</maml:name> <maml:description> <maml:para>Excluded Registry Keys from processing</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: ElevateFailureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElevateFailureAction</maml:name> <maml:description> <maml:para>Action when Agent is unable to generate a security token with elevated permissions</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: InvalidTargetProfileAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InvalidTargetProfileAction</maml:name> <maml:description> <maml:para>Action when an invalid or duplicate profile exists in the target</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LoggingLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoggingLevel</maml:name> <maml:description> <maml:para>General Logging Level</maml:para> <maml:para>Possible values: Info, Debug</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevelGeneral</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevelGeneral</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Info</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CustomAceUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomAceUsage</maml:name> <maml:description> <maml:para>If preserved, file and folder permissions are updated by adding the target security principals and keeping the source security principals; otherwise, the source security principals are removed from the permissions</maml:para> <maml:para>Possible values: Never, IfAmbiguous, Always</maml:para> </maml:description> <command:parameterValue required="true">CustomAceUsage</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CustomAceUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Always</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" variableLength="false">IfAmbiguous</command:parameterValue> <command:parameterValue required="false" variableLength="false">Always</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeFiles</maml:name> <maml:description> <maml:para>Excluded Files from processing</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: ExcludeSecurityIdentifiers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSecurityIdentifiers</maml:name> <maml:description> <maml:para>Excluded Security Identifiers from processing</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: ReparsePointRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReparsePointRules</maml:name> <maml:description> <maml:para>Reparse Tags that change how ReACL will process Reparse Points like Symbolic Links, Mount Points, and OneDrive</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0xA0000003:Update, 0xA000000C:Update, 0x9000001A:Full, 0x9000101A:Full, 0x9000201A:Full, 0x9000301A:Full, 0x9000401A:Full, 0x9000501A:Full, 0x9000601A:Full, 0x9000701A:Full, 0x9000801A:Full, 0x9000901A:Full, 0x9000A01A:Full, 0x9000B01A:Full, 0x9000C01A:Full, 0x9000D01A:Full, 0x9000E01A:Full, 0x9000F01A:Full</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceReACLProfile Identity (object). If specified, Identity object will be used to create the new DeviceReACLProfile and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceReACLProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceReACLProfile</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTDeviceReACLProfile -ProfileName Name -LoggingLevel Debug</maml:para> <maml:para>Creates a new DeviceReACLProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-BTDeviceReACLProfile --> <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-BTDeviceReACLProfile</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceReACLProfile</command:noun> <maml:description> <maml:para>Removes the DeviceReACLProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceReACLProfile -Identity DeviceReACLProfile(by object or id) cmdlet removes the specified DeviceReACLProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceReACLProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceReACLProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceReACLProfile identity: DeviceReACLProfileId or a DeviceReACLProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceReACLProfile identity: DeviceReACLProfileId or a DeviceReACLProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceReACLProfile identity: DeviceReACLProfileId or a DeviceReACLProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceReACLProfile -Identity 986</maml:para> <maml:para>Removes a DeviceReACLProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceReACLProfile --> <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-BTDeviceReACLProfile</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceReACLProfile</command:noun> <maml:description> <maml:para>Set new property values in a DeviceReACLProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceReACLProfile -Identity DeviceReACLProfile (by object or id) cmdlet sets properties in the specified DeviceReACLProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceReACLProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceReACLProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceReACLProfile identity: DeviceReACLProfileId or a DeviceReACLProfile object.</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> <!-- Parameter: CustomAceUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomAceUsage</maml:name> <maml:description> <maml:para>If preserved, file and folder permissions are updated by adding the target security principals and keeping the source security principals; otherwise, the source security principals are removed from the permissions</maml:para> <maml:para>Possible values: Never, IfAmbiguous, Always</maml:para> </maml:description> <command:parameterValue required="true">CustomAceUsage</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CustomAceUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Never</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" variableLength="false">IfAmbiguous</command:parameterValue> <command:parameterValue required="false" variableLength="false">Always</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ElevateFailureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElevateFailureAction</maml:name> <maml:description> <maml:para>Action when Agent is unable to generate a security token with elevated permissions</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeFiles</maml:name> <maml:description> <maml:para>Excluded Files from processing</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: ExcludePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePaths</maml:name> <maml:description> <maml:para>Excluded paths from processing</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: ExcludeRegistryKeys --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRegistryKeys</maml:name> <maml:description> <maml:para>Excluded Registry Keys from processing</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: ExcludeSecurityIdentifiers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSecurityIdentifiers</maml:name> <maml:description> <maml:para>Excluded Security Identifiers from processing</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: InvalidTargetProfileAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InvalidTargetProfileAction</maml:name> <maml:description> <maml:para>Action when an invalid or duplicate profile exists in the target</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LocalFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalFolders</maml:name> <maml:description> <maml:para>Only specified Local Folders and their subfolders to be processed</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: LoggingLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoggingLevel</maml:name> <maml:description> <maml:para>General Logging Level</maml:para> <maml:para>Possible values: Info, Debug</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevelGeneral</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevelGeneral</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Info</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: PreserveArchiveBit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveArchiveBit</maml:name> <maml:description> <maml:para>Preserve Archive Bit</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceReACLProfile 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: ReparsePointRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReparsePointRules</maml:name> <maml:description> <maml:para>Reparse Tags that change how ReACL will process Reparse Points like Symbolic Links, Mount Points, and OneDrive</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateDirectoryShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateDirectoryShares</maml:name> <maml:description> <maml:para>Update Directory Shares</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateFiles</maml:name> <maml:description> <maml:para>Update Files</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLocalFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLocalFolders</maml:name> <maml:description> <maml:para>Update Local Folders</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLocalGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLocalGroups</maml:name> <maml:description> <maml:para>Update Local Groups</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatePrinters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatePrinters</maml:name> <maml:description> <maml:para>Update Printers</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatePrinterShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatePrinterShares</maml:name> <maml:description> <maml:para>Update Printer Shares</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRegistry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRegistry</maml:name> <maml:description> <maml:para>Update Registry</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRightsAssignments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRightsAssignments</maml:name> <maml:description> <maml:para>Update Rights Assignments</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRoamingProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRoamingProfiles</maml:name> <maml:description> <maml:para>Update Roaming Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServiceAccounts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateServiceAccounts</maml:name> <maml:description> <maml:para>Update Service Accounts</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServices --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateServices</maml:name> <maml:description> <maml:para>Update Services</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateSystemAcls --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateSystemAcls</maml:name> <maml:description> <maml:para>Update System Acls</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateUserProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateUserProfiles</maml:name> <maml:description> <maml:para>Update User Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WhatIf --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Whether DeviceReACLProfile runs processing in simulation only</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceReACLProfile identity: DeviceReACLProfileId or a DeviceReACLProfile object.</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> <!-- Parameter: WhatIf --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Whether DeviceReACLProfile runs processing in simulation only</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateUserProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateUserProfiles</maml:name> <maml:description> <maml:para>Update User Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRightsAssignments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRightsAssignments</maml:name> <maml:description> <maml:para>Update Rights Assignments</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLocalGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLocalGroups</maml:name> <maml:description> <maml:para>Update Local Groups</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatePrinterShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatePrinterShares</maml:name> <maml:description> <maml:para>Update Printer Shares</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateDirectoryShares --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateDirectoryShares</maml:name> <maml:description> <maml:para>Update Directory Shares</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatePrinters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatePrinters</maml:name> <maml:description> <maml:para>Update Printers</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServices --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateServices</maml:name> <maml:description> <maml:para>Update Services</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateServiceAccounts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateServiceAccounts</maml:name> <maml:description> <maml:para>Update Service Accounts</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRegistry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRegistry</maml:name> <maml:description> <maml:para>Update Registry</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateLocalFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateLocalFolders</maml:name> <maml:description> <maml:para>Update Local Folders</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateFiles</maml:name> <maml:description> <maml:para>Update Files</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateSystemAcls --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateSystemAcls</maml:name> <maml:description> <maml:para>Update System Acls</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRoamingProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRoamingProfiles</maml:name> <maml:description> <maml:para>Update Roaming Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveArchiveBit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveArchiveBit</maml:name> <maml:description> <maml:para>Preserve Archive Bit</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>DeviceReACLProfile 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: LocalFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalFolders</maml:name> <maml:description> <maml:para>Only specified Local Folders and their subfolders to be processed</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: ExcludePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePaths</maml:name> <maml:description> <maml:para>Excluded paths from processing</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: ExcludeRegistryKeys --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRegistryKeys</maml:name> <maml:description> <maml:para>Excluded Registry Keys from processing</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: ElevateFailureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElevateFailureAction</maml:name> <maml:description> <maml:para>Action when Agent is unable to generate a security token with elevated permissions</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: InvalidTargetProfileAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InvalidTargetProfileAction</maml:name> <maml:description> <maml:para>Action when an invalid or duplicate profile exists in the target</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LoggingLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoggingLevel</maml:name> <maml:description> <maml:para>General Logging Level</maml:para> <maml:para>Possible values: Info, Debug</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevelGeneral</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevelGeneral</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Info</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CustomAceUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomAceUsage</maml:name> <maml:description> <maml:para>If preserved, file and folder permissions are updated by adding the target security principals and keeping the source security principals; otherwise, the source security principals are removed from the permissions</maml:para> <maml:para>Possible values: Never, IfAmbiguous, Always</maml:para> </maml:description> <command:parameterValue required="true">CustomAceUsage</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CustomAceUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Never</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" variableLength="false">IfAmbiguous</command:parameterValue> <command:parameterValue required="false" variableLength="false">Always</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeFiles</maml:name> <maml:description> <maml:para>Excluded Files from processing</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: ExcludeSecurityIdentifiers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSecurityIdentifiers</maml:name> <maml:description> <maml:para>Excluded Security Identifiers from processing</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: ReparsePointRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReparsePointRules</maml:name> <maml:description> <maml:para>Reparse Tags that change how ReACL will process Reparse Points like Symbolic Links, Mount Points, and OneDrive</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceReACLProfile identity: DeviceReACLProfileId or a DeviceReACLProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceReACLProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceReACLProfile</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-BTDeviceReACLProfile -Identity 25 -ProfileName "new name"</maml:para> <maml:para>Set a DeviceReACLProfile ProfileName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceShareReACLProfile --> <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-BTDeviceShareReACLProfile</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceShareReACLProfile</command:noun> <maml:description> <maml:para>Returns the DeviceShareReACLProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceShareReACLProfile -Identity returns the DeviceShareReACLProfile identified by its DeviceShareReACLProfileId, identity, or a DeviceShareReACLProfile object.</maml:para> <maml:para>Get-BTDeviceShareReACLProfile [-Filter] [-Limit] returns DeviceShareReACLProfiles matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceShareReACLProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceShareReACLProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceShareReACLProfile identity: DeviceShareReACLProfileId, ProfileName, or a DeviceShareReACLProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceShareReACLProfile</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceShareReACLProfileId , ProfileName, UpdateFiles, UpdateSystemAcls, UpdateRoamingProfiles, PreserveArchiveBit, NetworkErrorRetryCount, NetworkErrorRetryIntervalSec, WhatIf, ElevateFailureAction, LoggingLevel, CustomAceUsage.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceShareReACLProfile identity: DeviceShareReACLProfileId, ProfileName, or a DeviceShareReACLProfile object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are DeviceShareReACLProfileId , ProfileName, UpdateFiles, UpdateSystemAcls, UpdateRoamingProfiles, PreserveArchiveBit, NetworkErrorRetryCount, NetworkErrorRetryIntervalSec, WhatIf, ElevateFailureAction, LoggingLevel, CustomAceUsage.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceShareReACLProfile identity: DeviceShareReACLProfileId, ProfileName, or a DeviceShareReACLProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceShareReACLProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceShareReACLProfile</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-BTDeviceShareReACLProfile -Identity 986</maml:para> <maml:para>Get-BTDeviceShareReACLProfile -Identity 'My DeviceShareReACLProfile ProfileName'</maml:para> <maml:para>Get-BTDeviceShareReACLProfile -Identity $DeviceShareReACLProfile</maml:para> <maml:para>Returns a DeviceShareReACLProfile by DeviceShareReACLProfileId, identity, or a DeviceShareReACLProfile object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceShareReACLProfile</maml:para> <maml:para>Returns all DeviceShareReACLProfiles.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceShareReACLProfile -Filter "ProfileName -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceShareReACLProfiles whose ProfileName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceShareReACLProfile --> <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-BTDeviceShareReACLProfile</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceShareReACLProfile</command:noun> <maml:description> <maml:para>Create a new DeviceShareReACLProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-BTDeviceShareReACLProfile -Identity DeviceShareReACLProfile (by object) cmdlet creates the specified DeviceShareReACLProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-BTDeviceShareReACLProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceShareReACLProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceShareReACLProfile Identity (object). If specified, Identity object will be used to create the new DeviceShareReACLProfile and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceShareReACLProfile</maml:name> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Profile 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: CustomAceUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomAceUsage</maml:name> <maml:description> <maml:para>If preserved, file and folder permissions are updated by adding the target security principals and keeping the source security principals; otherwise, the source security principals are removed from the permissions</maml:para> <maml:para>Possible values: Never, IfAmbiguous, Always</maml:para> </maml:description> <command:parameterValue required="true">CustomAceUsage</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CustomAceUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Always</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" variableLength="false">IfAmbiguous</command:parameterValue> <command:parameterValue required="false" variableLength="false">Always</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ElevateFailureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElevateFailureAction</maml:name> <maml:description> <maml:para>Action when Agent is unable to generate a security token with elevated permissions</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeFiles</maml:name> <maml:description> <maml:para>Excluded Files from processing</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: ExcludePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePaths</maml:name> <maml:description> <maml:para>Excluded paths from processing</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\Windows, \WINNT, \I386, \Windows\I386, \Program Files, \PROGRAM FILES (x86), \MSOCACHE, \System Volume Information, \Recycler, \$RECYCLE.BIN, \CONFIG.MSI, \RECOVERY, \OEM, \Quarantine, \BOOT, \ProgramData\Microsoft\Windows Defender</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeRegistryKeys --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRegistryKeys</maml:name> <maml:description> <maml:para>Excluded Registry Keys from processing</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: ExcludeSecurityIdentifiers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSecurityIdentifiers</maml:name> <maml:description> <maml:para>Excluded Security Identifiers from processing</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: LoggingLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoggingLevel</maml:name> <maml:description> <maml:para>General Logging Level</maml:para> <maml:para>Possible values: Info, Debug</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevelGeneral</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevelGeneral</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Info</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: NetworkErrorRetryCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryCount</maml:name> <maml:description> <maml:para>Network Error Retry Count</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: NetworkErrorRetryIntervalSec --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryIntervalSec</maml:name> <maml:description> <maml:para>Network Error Retry Interval in Seconds</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>1</dev:defaultValue> </command:parameter> <!-- Parameter: NetworkErrorRetryList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryList</maml:name> <maml:description> <maml:para>Retry when these Network Error Codes are encountered</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>53, 64</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveArchiveBit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveArchiveBit</maml:name> <maml:description> <maml:para>Preserve Archive Bit</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReparsePointRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReparsePointRules</maml:name> <maml:description> <maml:para>Reparse Tags that change how ReACL will process Reparse Points like Symbolic Links, Mount Points, and OneDrive</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0xA0000003:Update, 0xA000000C:Update, 0x9000001A:Full, 0x9000101A:Full, 0x9000201A:Full, 0x9000301A:Full, 0x9000401A:Full, 0x9000501A:Full, 0x9000601A:Full, 0x9000701A:Full, 0x9000801A:Full, 0x9000901A:Full, 0x9000A01A:Full, 0x9000B01A:Full, 0x9000C01A:Full, 0x9000D01A:Full, 0x9000E01A:Full, 0x9000F01A:Full</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateFiles</maml:name> <maml:description> <maml:para>Update Files</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRoamingProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRoamingProfiles</maml:name> <maml:description> <maml:para>Update Roaming Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateSystemAcls --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateSystemAcls</maml:name> <maml:description> <maml:para>Update System Acls</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: WhatIf --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Whether DeviceReACLProfile runs processing in simulation only</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceShareReACLProfile Identity (object). If specified, Identity object will be used to create the new DeviceShareReACLProfile and other parameters will be ignored.</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> <!-- Parameter: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Profile 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: UpdateFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateFiles</maml:name> <maml:description> <maml:para>Update Files</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateSystemAcls --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateSystemAcls</maml:name> <maml:description> <maml:para>Update System Acls</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRoamingProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRoamingProfiles</maml:name> <maml:description> <maml:para>Update Roaming Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveArchiveBit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveArchiveBit</maml:name> <maml:description> <maml:para>Preserve Archive Bit</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePaths</maml:name> <maml:description> <maml:para>Excluded paths from processing</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\Windows, \WINNT, \I386, \Windows\I386, \Program Files, \PROGRAM FILES (x86), \MSOCACHE, \System Volume Information, \Recycler, \$RECYCLE.BIN, \CONFIG.MSI, \RECOVERY, \OEM, \Quarantine, \BOOT, \ProgramData\Microsoft\Windows Defender</dev:defaultValue> </command:parameter> <!-- Parameter: NetworkErrorRetryList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryList</maml:name> <maml:description> <maml:para>Retry when these Network Error Codes are encountered</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>53, 64</dev:defaultValue> </command:parameter> <!-- Parameter: NetworkErrorRetryCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryCount</maml:name> <maml:description> <maml:para>Network Error Retry Count</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: NetworkErrorRetryIntervalSec --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryIntervalSec</maml:name> <maml:description> <maml:para>Network Error Retry Interval in Seconds</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>1</dev:defaultValue> </command:parameter> <!-- Parameter: ElevateFailureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElevateFailureAction</maml:name> <maml:description> <maml:para>Action when Agent is unable to generate a security token with elevated permissions</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LoggingLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoggingLevel</maml:name> <maml:description> <maml:para>General Logging Level</maml:para> <maml:para>Possible values: Info, Debug</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevelGeneral</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevelGeneral</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Info</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: WhatIf --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Whether DeviceReACLProfile runs processing in simulation only</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CustomAceUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomAceUsage</maml:name> <maml:description> <maml:para>If preserved, file and folder permissions are updated by adding the target security principals and keeping the source security principals; otherwise, the source security principals are removed from the permissions</maml:para> <maml:para>Possible values: Never, IfAmbiguous, Always</maml:para> </maml:description> <command:parameterValue required="true">CustomAceUsage</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CustomAceUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Always</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" variableLength="false">IfAmbiguous</command:parameterValue> <command:parameterValue required="false" variableLength="false">Always</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeRegistryKeys --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRegistryKeys</maml:name> <maml:description> <maml:para>Excluded Registry Keys from processing</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: ExcludeFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeFiles</maml:name> <maml:description> <maml:para>Excluded Files from processing</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: ExcludeSecurityIdentifiers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSecurityIdentifiers</maml:name> <maml:description> <maml:para>Excluded Security Identifiers from processing</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: ReparsePointRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReparsePointRules</maml:name> <maml:description> <maml:para>Reparse Tags that change how ReACL will process Reparse Points like Symbolic Links, Mount Points, and OneDrive</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0xA0000003:Update, 0xA000000C:Update, 0x9000001A:Full, 0x9000101A:Full, 0x9000201A:Full, 0x9000301A:Full, 0x9000401A:Full, 0x9000501A:Full, 0x9000601A:Full, 0x9000701A:Full, 0x9000801A:Full, 0x9000901A:Full, 0x9000A01A:Full, 0x9000B01A:Full, 0x9000C01A:Full, 0x9000D01A:Full, 0x9000E01A:Full, 0x9000F01A:Full</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceShareReACLProfile Identity (object). If specified, Identity object will be used to create the new DeviceShareReACLProfile and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceShareReACLProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceShareReACLProfile</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTDeviceShareReACLProfile -ProfileName Name -WhatIf $true</maml:para> <maml:para>Creates a new DeviceShareReACLProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-BTDeviceShareReACLProfile --> <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-BTDeviceShareReACLProfile</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceShareReACLProfile</command:noun> <maml:description> <maml:para>Removes the DeviceShareReACLProfiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceShareReACLProfile -Identity DeviceShareReACLProfile(by object or id) cmdlet removes the specified DeviceShareReACLProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceShareReACLProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceShareReACLProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceShareReACLProfile identity: DeviceShareReACLProfileId or a DeviceShareReACLProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceShareReACLProfile identity: DeviceShareReACLProfileId or a DeviceShareReACLProfile object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceShareReACLProfile identity: DeviceShareReACLProfileId or a DeviceShareReACLProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceShareReACLProfile -Identity 986</maml:para> <maml:para>Removes a DeviceShareReACLProfile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceShareReACLProfile --> <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-BTDeviceShareReACLProfile</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceShareReACLProfile</command:noun> <maml:description> <maml:para>Set new property values in a DeviceShareReACLProfile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceShareReACLProfile -Identity DeviceShareReACLProfile (by object or id) cmdlet sets properties in the specified DeviceShareReACLProfile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceShareReACLProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceShareReACLProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceShareReACLProfile identity: DeviceShareReACLProfileId or a DeviceShareReACLProfile object.</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> <!-- Parameter: CustomAceUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomAceUsage</maml:name> <maml:description> <maml:para>If preserved, file and folder permissions are updated by adding the target security principals and keeping the source security principals; otherwise, the source security principals are removed from the permissions</maml:para> <maml:para>Possible values: Never, IfAmbiguous, Always</maml:para> </maml:description> <command:parameterValue required="true">CustomAceUsage</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CustomAceUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Never</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" variableLength="false">IfAmbiguous</command:parameterValue> <command:parameterValue required="false" variableLength="false">Always</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ElevateFailureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElevateFailureAction</maml:name> <maml:description> <maml:para>Action when Agent is unable to generate a security token with elevated permissions</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeFiles</maml:name> <maml:description> <maml:para>Excluded Files from processing</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: ExcludePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePaths</maml:name> <maml:description> <maml:para>Excluded paths from processing</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: ExcludeRegistryKeys --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRegistryKeys</maml:name> <maml:description> <maml:para>Excluded Registry Keys from processing</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: ExcludeSecurityIdentifiers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSecurityIdentifiers</maml:name> <maml:description> <maml:para>Excluded Security Identifiers from processing</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: LoggingLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoggingLevel</maml:name> <maml:description> <maml:para>General Logging Level</maml:para> <maml:para>Possible values: Info, Debug</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevelGeneral</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevelGeneral</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Info</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: NetworkErrorRetryCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryCount</maml:name> <maml:description> <maml:para>Network Error Retry Count</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: NetworkErrorRetryIntervalSec --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryIntervalSec</maml:name> <maml:description> <maml:para>Network Error Retry Interval in Seconds</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: NetworkErrorRetryList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryList</maml:name> <maml:description> <maml:para>Retry when these Network Error Codes are encountered</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: PreserveArchiveBit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveArchiveBit</maml:name> <maml:description> <maml:para>Preserve Archive Bit</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Profile 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: ReparsePointRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReparsePointRules</maml:name> <maml:description> <maml:para>Reparse Tags that change how ReACL will process Reparse Points like Symbolic Links, Mount Points, and OneDrive</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateFiles</maml:name> <maml:description> <maml:para>Update Files</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRoamingProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRoamingProfiles</maml:name> <maml:description> <maml:para>Update Roaming Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateSystemAcls --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateSystemAcls</maml:name> <maml:description> <maml:para>Update System Acls</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WhatIf --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Whether DeviceReACLProfile runs processing in simulation only</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceShareReACLProfile identity: DeviceShareReACLProfileId or a DeviceShareReACLProfile object.</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> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Profile 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: UpdateFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateFiles</maml:name> <maml:description> <maml:para>Update Files</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateSystemAcls --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateSystemAcls</maml:name> <maml:description> <maml:para>Update System Acls</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateRoamingProfiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRoamingProfiles</maml:name> <maml:description> <maml:para>Update Roaming Profiles</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveArchiveBit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveArchiveBit</maml:name> <maml:description> <maml:para>Preserve Archive Bit</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePaths</maml:name> <maml:description> <maml:para>Excluded paths from processing</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: NetworkErrorRetryList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryList</maml:name> <maml:description> <maml:para>Retry when these Network Error Codes are encountered</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: NetworkErrorRetryCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryCount</maml:name> <maml:description> <maml:para>Network Error Retry Count</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: NetworkErrorRetryIntervalSec --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkErrorRetryIntervalSec</maml:name> <maml:description> <maml:para>Network Error Retry Interval in Seconds</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: ElevateFailureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElevateFailureAction</maml:name> <maml:description> <maml:para>Action when Agent is unable to generate a security token with elevated permissions</maml:para> <maml:para>Possible values: Fatal, Error, Warn, Info</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Fatal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LoggingLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoggingLevel</maml:name> <maml:description> <maml:para>General Logging Level</maml:para> <maml:para>Possible values: Info, Debug</maml:para> </maml:description> <command:parameterValue required="true">LoggingLevelGeneral</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LoggingLevelGeneral</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Info</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: WhatIf --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Whether DeviceReACLProfile runs processing in simulation only</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CustomAceUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomAceUsage</maml:name> <maml:description> <maml:para>If preserved, file and folder permissions are updated by adding the target security principals and keeping the source security principals; otherwise, the source security principals are removed from the permissions</maml:para> <maml:para>Possible values: Never, IfAmbiguous, Always</maml:para> </maml:description> <command:parameterValue required="true">CustomAceUsage</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CustomAceUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Never</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Never</command:parameterValue> <command:parameterValue required="false" variableLength="false">IfAmbiguous</command:parameterValue> <command:parameterValue required="false" variableLength="false">Always</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeRegistryKeys --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRegistryKeys</maml:name> <maml:description> <maml:para>Excluded Registry Keys from processing</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: ExcludeFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeFiles</maml:name> <maml:description> <maml:para>Excluded Files from processing</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: ExcludeSecurityIdentifiers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeSecurityIdentifiers</maml:name> <maml:description> <maml:para>Excluded Security Identifiers from processing</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: ReparsePointRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReparsePointRules</maml:name> <maml:description> <maml:para>Reparse Tags that change how ReACL will process Reparse Points like Symbolic Links, Mount Points, and OneDrive</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceShareReACLProfile identity: DeviceShareReACLProfileId or a DeviceShareReACLProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceShareReACLProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceShareReACLProfile</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-BTDeviceShareReACLProfile -Identity 25 -ProfileName "new value"</maml:para> <maml:para>Set a DeviceShareReACLProfile ProfileName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTDeviceTask --> <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-BTDeviceTask</command:name> <command:verb>Get</command:verb> <command:noun>BTDeviceTask</command:noun> <maml:description> <maml:para>Returns the DeviceTasks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTDeviceTask -Identity returns the DeviceTask identified by its DeviceTaskId, identity, or a DeviceTask object.</maml:para> <maml:para>Get-BTDeviceTask [-Filter] [-Limit] returns DeviceTasks matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTDeviceTask cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTDeviceTask</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceTask identity: DeviceTaskId, TaskName, or a DeviceTask object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTDeviceTask</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "CmdletGenerator.Templates.SDKModelPropertyInfo -like 'My*'". The supported properties are DeviceTaskId TaskName, TaskType, Script, RollbackScript, Description, IsAutomaticRollback, RequiresCutoverCredentials, RequiresNetworkProfile, RequiresMigrationProfile, RequiresGlobalVariables, RequiresOfflineDomainJoin,\ RequiresEntraIDJoin, TimeoutSeconds, RetryCount, UpdateIntervalSeconds, IsSystemCopy and IsSystem.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceTask identity: DeviceTaskId, TaskName, or a DeviceTask object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "CmdletGenerator.Templates.SDKModelPropertyInfo -like 'My*'". The supported properties are DeviceTaskId TaskName, TaskType, Script, RollbackScript, Description, IsAutomaticRollback, RequiresCutoverCredentials, RequiresNetworkProfile, RequiresMigrationProfile, RequiresGlobalVariables, RequiresOfflineDomainJoin,\ RequiresEntraIDJoin, TimeoutSeconds, RetryCount, UpdateIntervalSeconds, IsSystemCopy and IsSystem.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceTask identity: DeviceTaskId, TaskName, or a DeviceTask object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceTask --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceTask</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-BTDeviceTask -Identity 986</maml:para> <maml:para>Get-BTDeviceTask -Identity 'My DeviceTask TaskName'</maml:para> <maml:para>Get-BTDeviceTask -Identity $DeviceTask</maml:para> <maml:para>Returns a DeviceTask by DeviceTaskId, identity, or a DeviceTask object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceTask</maml:para> <maml:para>Returns all DeviceTasks.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTDeviceTask -Filter "CmdletGenerator.Templates.SDKModelPropertyInfo -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DeviceTasks whose CmdletGenerator.Templates.SDKModelPropertyInfo starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTDeviceTask --> <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-BTDeviceTask</command:name> <command:verb>New</command:verb> <command:noun>BTDeviceTask</command:noun> </command:details> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-BTDeviceTask</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceTask Identity (object). If specified, Identity object will be used to create the new DeviceTask and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-BTDeviceTask</maml:name> <!-- Parameter: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>DeviceTask Description</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: IsAutomaticRollback --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAutomaticRollback</maml:name> <maml:description> <maml:para>If true, automatic rollback on error is added to the task</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IsSystem --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSystem</maml:name> <maml:description> <maml:para>True if system DeviceTask</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IsSystemCopy --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSystemCopy</maml:name> <maml:description> <maml:para>True if task is created by copying a system one</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresCutoverCredentials --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresCutoverCredentials</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $CutoverCredentials_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresEntraIDJoin --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresEntraIDJoin</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $AzureBulkEnrollment_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresGlobalVariables --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresGlobalVariables</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the Global Variables</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresMigrationProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresMigrationProfile</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $MigrationOption_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresNetworkProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresNetworkProfile</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $NetworkProfile_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresOfflineDomainJoin --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresOfflineDomainJoin</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $CredentialCache_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RetryCount --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>The number of times the process will be retried</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: RollbackScript --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RollbackScript</maml:name> <maml:description> <maml:para>Rollback script to be executed in case of task failure</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: Script --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>Script to be executed</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: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>DeviceTask 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: TaskType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskType</maml:name> <maml:description> <maml:para>DeviceTask Type</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: TimeoutSeconds --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>The number of seconds the process will be attempted before timing out</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: UpdateIntervalSeconds --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateIntervalSeconds</maml:name> <maml:description> <maml:para>The number of seconds between process runs</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceTask Identity (object). If specified, Identity object will be used to create the new DeviceTask and other parameters will be ignored.</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> <!-- Parameter: TaskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>DeviceTask 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: TaskType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskType</maml:name> <maml:description> <maml:para>DeviceTask Type</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: Script --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>Script to be executed</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: RollbackScript --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RollbackScript</maml:name> <maml:description> <maml:para>Rollback script to be executed in case of task failure</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: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>DeviceTask Description</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: IsAutomaticRollback --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAutomaticRollback</maml:name> <maml:description> <maml:para>If true, automatic rollback on error is added to the task</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresCutoverCredentials --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresCutoverCredentials</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $CutoverCredentials_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresNetworkProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresNetworkProfile</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $NetworkProfile_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresMigrationProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresMigrationProfile</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $MigrationOption_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresGlobalVariables --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresGlobalVariables</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the Global Variables</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresOfflineDomainJoin --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresOfflineDomainJoin</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $CredentialCache_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresEntraIDJoin --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresEntraIDJoin</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $AzureBulkEnrollment_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutSeconds --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>The number of seconds the process will be attempted before timing out</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: RetryCount --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>The number of times the process will be retried</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: UpdateIntervalSeconds --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateIntervalSeconds</maml:name> <maml:description> <maml:para>The number of seconds between process runs</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: IsSystemCopy --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSystemCopy</maml:name> <maml:description> <maml:para>True if task is created by copying a system one</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IsSystem --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSystem</maml:name> <maml:description> <maml:para>True if system DeviceTask</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceTask Identity (object). If specified, Identity object will be used to create the new DeviceTask and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceTask --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceTask</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-BTDeviceTask --> <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-BTDeviceTask</command:name> <command:verb>Remove</command:verb> <command:noun>BTDeviceTask</command:noun> <maml:description> <maml:para>Removes the DeviceTasks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-BTDeviceTask -Identity DeviceTask(by object or id) cmdlet removes the specified DeviceTask.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Remove-BTDeviceTask cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Remove-BTDeviceTask</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceTask identity: DeviceTaskId or a DeviceTask object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceTask identity: DeviceTaskId or a DeviceTask object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceTask identity: DeviceTaskId or a DeviceTask object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-BTDeviceTask -Identity 986</maml:para> <maml:para>Removes a DeviceTask.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTDeviceTask --> <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-BTDeviceTask</command:name> <command:verb>Set</command:verb> <command:noun>BTDeviceTask</command:noun> <maml:description> <maml:para>Set new property values in a DeviceTask.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-BTDeviceTask -Identity DeviceTask (by object or id) cmdlet sets properties in the specified DeviceTask.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-BTDeviceTask cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-BTDeviceTask</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceTask identity: DeviceTaskId or a DeviceTask object.</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> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>DeviceTask Description</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: IsAutomaticRollback --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAutomaticRollback</maml:name> <maml:description> <maml:para>If true, automatic rollback on error is added to the task</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IsSystem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSystem</maml:name> <maml:description> <maml:para>True if system DeviceTask</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IsSystemCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSystemCopy</maml:name> <maml:description> <maml:para>True if task is created by copying a system one</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresCutoverCredentials --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresCutoverCredentials</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $CutoverCredentials_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresEntraIDJoin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresEntraIDJoin</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $AzureBulkEnrollment_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresGlobalVariables --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresGlobalVariables</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the Global Variables</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresMigrationProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresMigrationProfile</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $MigrationOption_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresNetworkProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresNetworkProfile</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $NetworkProfile_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresOfflineDomainJoin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresOfflineDomainJoin</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $CredentialCache_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RetryCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>The number of times the process will be retried</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: RollbackScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RollbackScript</maml:name> <maml:description> <maml:para>Rollback script to be executed in case of task failure</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: Script --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>Script to be executed</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TaskName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>DeviceTask 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: TaskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskType</maml:name> <maml:description> <maml:para>DeviceTask Type</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: TimeoutSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>The number of seconds the process will be attempted before timing out</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: UpdateIntervalSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateIntervalSeconds</maml:name> <maml:description> <maml:para>The number of seconds between process runs</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DeviceTask identity: DeviceTaskId or a DeviceTask object.</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> <!-- Parameter: TaskName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>DeviceTask 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: TaskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskType</maml:name> <maml:description> <maml:para>DeviceTask Type</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: Script --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>Script to be executed</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: RollbackScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RollbackScript</maml:name> <maml:description> <maml:para>Rollback script to be executed in case of task failure</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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>DeviceTask Description</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: IsAutomaticRollback --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAutomaticRollback</maml:name> <maml:description> <maml:para>If true, automatic rollback on error is added to the task</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresCutoverCredentials --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresCutoverCredentials</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $CutoverCredentials_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresNetworkProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresNetworkProfile</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $NetworkProfile_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresMigrationProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresMigrationProfile</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $MigrationOption_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresGlobalVariables --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresGlobalVariables</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the Global Variables</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresOfflineDomainJoin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresOfflineDomainJoin</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $CredentialCache_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RequiresEntraIDJoin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiresEntraIDJoin</maml:name> <maml:description> <maml:para>If true, the PowerShell script or Command Line command includes the $AzureBulkEnrollment_XXXXX parameters</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>The number of seconds the process will be attempted before timing out</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: RetryCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>The number of times the process will be retried</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: UpdateIntervalSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateIntervalSeconds</maml:name> <maml:description> <maml:para>The number of seconds between process runs</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: IsSystemCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSystemCopy</maml:name> <maml:description> <maml:para>True if task is created by copying a system one</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IsSystem --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSystem</maml:name> <maml:description> <maml:para>True if system DeviceTask</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DeviceTask identity: DeviceTaskId or a DeviceTask object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DeviceTask --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DeviceTask</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-BTDeviceTask -Identity 25 -TaskName "new value"</maml:para> <maml:para>Set a DeviceTask TaskName property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTDiscovery --> <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-BTDiscovery</command:name> <command:verb>Start</command:verb> <command:noun>BTDiscovery</command:noun> <maml:description> <maml:para>Starts a Power365 Discovery operation for the specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTDiscovery -Identity starts Discovery of an Environment identified by the TenantId, or Environment object.</maml:para> <maml:para>Start-BTDiscovery [-DiscoveryDeltaTimestamp] starts Discovery of an Environment for objects with changes after the specified DateTime.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTDiscovery cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Start-BTDiscovery</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</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> <!-- Parameter: DiscoveryDeltaTimestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryDeltaTimestamp</maml:name> <maml:description> <maml:para>Limits the scope of the discovery to objects changed after the DiscoveryDeltaTimestamp.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</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> <!-- Parameter: DiscoveryDeltaTimestamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryDeltaTimestamp</maml:name> <maml:description> <maml:para>Limits the scope of the discovery to objects changed after the DiscoveryDeltaTimestamp.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Environment --> <command:returnValue> <dev:type> <maml:name>System.Environment</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTDiscovery -Identity 986</maml:para> <maml:para>Start-BTDiscovery -Identity $environment</maml:para> <maml:para>Starts Discovery of an Environment by TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Start-BTDiscovery -Identity $environment -DiscoveryDeltaTimestamp $changedAfterDateTime</maml:para> <maml:para>Starts Discovery of an Environment for items that have changes newer than $changedAfterDateTime</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTEnvironment --> <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-BTEnvironment</command:name> <command:verb>Get</command:verb> <command:noun>BTEnvironment</command:noun> <maml:description> <maml:para>Returns the statuses of Power365 Environments.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTEnvironment -Identity returns the Environment identified by its TenantId, TenantName, TenantGuid or a Environment object.</maml:para> <maml:para>Get-BTEnvironment [-Filter] [-Limit] returns Environment matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTEnvironment cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTEnvironment</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTEnvironment</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "TenantName -like 'My*'". The supported properties are TenantId, TenantName, TenantGuid, DiscoveryFrequencyHours, T2TPowerShellUsername, PFPowerShellUsername, SkipUserDiscovery, IsHybrid, IsConnected, DiscoveryDeltaTimestamp, DiscoveryStarted, DiscoveryFinished, DiscoveryState.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "TenantName -like 'My*'". The supported properties are TenantId, TenantName, TenantGuid, DiscoveryFrequencyHours, T2TPowerShellUsername, PFPowerShellUsername, SkipUserDiscovery, IsHybrid, IsConnected, DiscoveryDeltaTimestamp, DiscoveryStarted, DiscoveryFinished, DiscoveryState.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Environment identity: TenantId, TenantName, TenantGuid, or Environment object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Environment --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Models.Environment</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-BTEnvironment -Identity 986</maml:para> <maml:para>Get-BTEnvironment -Identity $environment</maml:para> <maml:para>Returns a Environment by TenantId, TenantName, TenantGuid, or an Environment object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTEnvironment</maml:para> <maml:para>Returns all Environments.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTEnvironment -Identity $environment -Filter "IsConnected -eq true" -Limit 10</maml:para> <maml:para>Returns the first 10 Environments where IsConnected is true.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTEnvironment --> <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-BTEnvironment</command:name> <command:verb>Set</command:verb> <command:noun>BTEnvironment</command:noun> <maml:description> <maml:para>Updates Power365 Environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-BTEnvironment -Identity [-SkipUserDiscovery] sets the Environment to Skip User Discovery.</maml:para> <maml:para>Set-BTEnvironment -Identity [-DiscoveryFrequencyHours] sets the Environment Discovery Frequency.</maml:para> <maml:para>Set-BTEnvironment -Identity [-DiscoveryState] sets the Environment Discovery State to Enabled or Disabled.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Set-BTEnvironment cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-BTEnvironment</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, or Environment object.</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> <!-- Parameter: DiscoveryFrequencyHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryFrequencyHours</maml:name> <maml:description> <maml:para>How often to perform discovery.</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: DiscoveryState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryState</maml:name> <maml:description> <maml:para>New Discovery state: Enabled or Disabled</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipUserDiscovery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipUserDiscovery</maml:name> <maml:description> <maml:para>Skip Discovery of users.</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: TenantId, TenantName, or Environment object.</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> <!-- Parameter: DiscoveryState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryState</maml:name> <maml:description> <maml:para>New Discovery state: Enabled or Disabled</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: SkipUserDiscovery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipUserDiscovery</maml:name> <maml:description> <maml:para>Skip Discovery of users.</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: DiscoveryFrequencyHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoveryFrequencyHours</maml:name> <maml:description> <maml:para>How often to perform discovery.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Environment identity: TenantId, TenantName, or Environment object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Environment --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Models.Environment</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-BTEnvironment -Identity $environment -SkipUserDiscovery $true</maml:para> <maml:para>Set the Environment SkipUserDiscovery flag.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Set-BTEnvironment -Identity 'Tenant XYZ' -DiscoveryFrequencyHours 12</maml:para> <maml:para>Sets the Environment Discovery Frequency to 12 hours.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Set-BTEnvironment -Identity 983 -DiscoveryState Disabled</maml:para> <maml:para>sets the Environment Discovery State to Disabled.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTLog --> <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-BTLog</command:name> <command:verb>Get</command:verb> <command:noun>BTLog</command:noun> <maml:description> <maml:para>Returns Power365 Prepare, Sync, Cutover, or Environment Discovery Logs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTLog -Identity <id> -Prepare returns Prepare Logs.</maml:para> <maml:para>Get-BTLog -Identity <id> -Sync returns Sync Logs.</maml:para> <maml:para>Get-BTLog -Identity <id> -Cutover returns Cutover Logs.</maml:para> <maml:para>Get-BTLog -Identity <id> -Discovery returns Environment Discovery Logs.</maml:para> <maml:para>Get-BTLog -Identity <object> returns Logs for the specified Prepare, Sync, Cutover, or Environment object.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTLog cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</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> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByPrepare --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</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> <!-- Parameter: Prepare --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Prepare</maml:name> <maml:description> <maml:para>Identity is a PrepareJobId.</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: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySync --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</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> <!-- Parameter: Sync --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Sync</maml:name> <maml:description> <maml:para>Identity is a SyncJobId.</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: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByCutover --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</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> <!-- Parameter: Cutover --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cutover</maml:name> <maml:description> <maml:para>Identity is a CutoverJobId.</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: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByEnvironment --> <command:syntaxItem> <maml:name>Get-BTLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</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> <!-- Parameter: Discovery --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Discovery</maml:name> <maml:description> <maml:para>Identity is a TenantId.</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: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Prepare --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Prepare</maml:name> <maml:description> <maml:para>Identity is a PrepareJobId.</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: Sync --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Sync</maml:name> <maml:description> <maml:para>Identity is a SyncJobId.</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: Cutover --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Cutover</maml:name> <maml:description> <maml:para>Identity is a CutoverJobId.</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: Discovery --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Discovery</maml:name> <maml:description> <maml:para>Identity is a TenantId.</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: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Identity: PrepareJobId/SyncJobId/CutoverJobId/TenantId or Prepare/Sync/Cutover/Environment object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</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-BTLog -Identity 355 -Prepare</maml:para> <maml:para>Get-BTLog -Identity 356 -Sync</maml:para> <maml:para>Get-BTLog -Identity 357 -Cutover</maml:para> <maml:para>Get-BTLog -Identity 368 -Discovery</maml:para> <maml:para>Returns Logs for a Prepare, Sync, Cutover, or Environment by id.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTLog -Identity $prepare</maml:para> <maml:para>Get-BTLog -Identity $sync</maml:para> <maml:para>Get-BTLog -Identity $cutover</maml:para> <maml:para>Get-BTLog -Identity $environment</maml:para> <maml:para>Returns Logs for a Prepare, Sync, Cutover, or Environment by object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTPrepare --> <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-BTPrepare</command:name> <command:verb>Get</command:verb> <command:noun>BTPrepare</command:noun> <maml:description> <maml:para>Returns the statuses of Power365 Prepare operations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTPrepare -Identity returns the Prepare identified by its PrepareJobId, or a Prepare object.</maml:para> <maml:para>Get-BTPrepare [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Prepares matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTPrepare</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Prepare identity: PrepareJobId, or Prepare object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTPrepare</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are PrepareJobId, UserId, PrepareState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</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> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Prepare identity: PrepareJobId, or Prepare object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</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> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are PrepareJobId, UserId, PrepareState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Prepare identity: PrepareJobId, or Prepare object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PrepareJob --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.PrepareJob</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-BTPrepare -Identity 986</maml:para> <maml:para>Get-BTPrepare -Identity $prepare</maml:para> <maml:para>Returns a Prepare by PrepareJobId, or a Prepare object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTPrepare</maml:para> <maml:para>Returns all Prepares.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTPrepare -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10</maml:para> <maml:para>Returns the most recent 10 Prepares for the specified User where IsComplete is true.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTPrepare --> <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-BTPrepare</command:name> <command:verb>Start</command:verb> <command:noun>BTPrepare</command:noun> <maml:description> <maml:para>Start Prepare operations for Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTPrepare -User starts a Prepare operation for a User.</maml:para> <maml:para>Start-BTPrepare -Wave starts a Prepare operation for a Wave.</maml:para> <maml:para>Start-BTPrepare -InputObject starts a Prepare operation for a User or Wave.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTPrepare cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByUser --> <command:syntaxItem> <maml:name>Start-BTPrepare</maml:name> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByWave --> <command:syntaxItem> <maml:name>Start-BTPrepare</maml:name> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInputObject --> <command:syntaxItem> <maml:name>Start-BTPrepare</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</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> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</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> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTPrepare -User 356</maml:para> <maml:para>Start-BTPrepare -User joe@contoso.com</maml:para> <maml:para>Start-BTPrepare -User $user</maml:para> <maml:para>Starts a Prepare for a User by id, identity, or User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Start-BTPrepare -Wave 356</maml:para> <maml:para>Start-BTPrepare -Wave 'My Wave'</maml:para> <maml:para>Start-BTPrepare -Wave $wave</maml:para> <maml:para>Starts a Prepare for a Wave by id, identity, or Wave object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>$usersOrWaves | Start-BTPrepare</maml:para> <maml:para>Starts a Prepare for each input object, which can be a User or a Wave object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTProfile --> <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-BTProfile</command:name> <command:verb>Get</command:verb> <command:noun>BTProfile</command:noun> <maml:description> <maml:para>Returns Power365 Profiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTProfile -Identity returns the Profile identified by its ProfileId, ProfileName, or a Profile object.</maml:para> <maml:para>Get-BTProfile [-Project] [-Filter] [-Limit] returns Profiles matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Profile identity: ProfileId, ProfileName, or Profile object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTProfile</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are CutoverNotificationBody, CutoverNotificationSubject, CutoverOutlookAgentEnabled, CutoverOutlookAgentSilent, CutoverSkipNoticeODB, CutoverSkipPermissionsFinalSync, CutoverSkipPermissionsInitialSync, CutoverSkipPermissionsNormalSync, CutoverWaitsOnOutlookAgent, ErrorFolderThreshold, ErrorFolderThresholdODB, ErrorItemThreshold, ErrorItemThresholdODB, FilterCalendarMaxAgeDays, FilterCalendarNotAfter, FilterCalendarNotBefore, FilterCalendarType, FilterMailMaxAgeDays, FilterMailNotAfter, FilterMailNotBefore, FilterMailType, FilterNotesMaxAgeDays, FilterNotesNotAfter, FilterNotesNotBefore, FilterNotesType, FilterSizeMaxMB, FilterSizeType, FilterTasksMaxAgeDays, FilterTasksNotAfter, FilterTasksNotBefore, FilterTasksType, IsDefault, LastUpdate, LicensingMode, LicensingSKU, LicensingSKUTeams, MigrateArchiveMailbox, MigrateAutomaticReplies, MigrateContacts, MigrateDeletedItems, MigrateLitHolds, MigrateOneDriveForBusiness, MigratePlanner, MigrateRules, MigrateSignatures, OneNoteFinalSyncOnly, PrepareUnifiedGroupsAsTeams, PrepareUnifiedGroupsAndTeams, PrepareUsers, ProfileId, ProfileName, ProjectId, and ProjectName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Profile identity: ProfileId, ProfileName, or Profile object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProfileName -like 'My*'". The supported properties are CutoverNotificationBody, CutoverNotificationSubject, CutoverOutlookAgentEnabled, CutoverOutlookAgentSilent, CutoverSkipNoticeODB, CutoverSkipPermissionsFinalSync, CutoverSkipPermissionsInitialSync, CutoverSkipPermissionsNormalSync, CutoverWaitsOnOutlookAgent, ErrorFolderThreshold, ErrorFolderThresholdODB, ErrorItemThreshold, ErrorItemThresholdODB, FilterCalendarMaxAgeDays, FilterCalendarNotAfter, FilterCalendarNotBefore, FilterCalendarType, FilterMailMaxAgeDays, FilterMailNotAfter, FilterMailNotBefore, FilterMailType, FilterNotesMaxAgeDays, FilterNotesNotAfter, FilterNotesNotBefore, FilterNotesType, FilterSizeMaxMB, FilterSizeType, FilterTasksMaxAgeDays, FilterTasksNotAfter, FilterTasksNotBefore, FilterTasksType, IsDefault, LastUpdate, LicensingMode, LicensingSKU, LicensingSKUTeams, MigrateArchiveMailbox, MigrateAutomaticReplies, MigrateContacts, MigrateDeletedItems, MigrateLitHolds, MigrateOneDriveForBusiness, MigratePlanner, MigrateRules, MigrateSignatures, OneNoteFinalSyncOnly, PrepareUnifiedGroupsAsTeams, PrepareUnifiedGroupsAndTeams, PrepareUsers, ProfileId, ProfileName, ProjectId, and ProjectName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Profile identity: ProfileId, ProfileName, or Profile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Profile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Profile</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-BTProfile -Identity 986</maml:para> <maml:para>Get-BTProfile -Identity 'My Profile'</maml:para> <maml:para>Get-BTProfile -Identity $profile</maml:para> <maml:para>Returns a Profile by ProfileId, ProfileName, or a Profile object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProfile</maml:para> <maml:para>Returns all Profiles.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProfile -Filter "ProfileName -like 'M*' -Limit 10</maml:para> <maml:para>Returns the first 10 Profiles whose ProfileName begins with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTProject --> <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-BTProject</command:name> <command:verb>Get</command:verb> <command:noun>BTProject</command:noun> <maml:description> <maml:para>Returns Power365 Projects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTProject -Identity returns the Project identified by its ProjectId, ProjectName, or a Project object.</maml:para> <maml:para>Get-BTProject [-Filter] [-Limit] returns Projects matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTProject</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTProject</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties are ProjectId, ProjectName, and ProjectType.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties are ProjectId, ProjectName, and ProjectType.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Project --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Project</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-BTProject -Identity 986</maml:para> <maml:para>Get-BTProject -Identity 'My Project'</maml:para> <maml:para>Get-BTProject -Identity $project</maml:para> <maml:para>Returns a Project by ProjectId, ProjectName, or a Project object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProject</maml:para> <maml:para>Returns all Projects.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTProject -Filter "ProjectName -like 'M*'" -Limit 10</maml:para> <maml:para>Returns the first 10 Projects whose ProjectName begins with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTProject --> <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-BTProject</command:name> <command:verb>Set</command:verb> <command:noun>BTProject</command:noun> <maml:description> <maml:para>Updates a Power365 Project, or sets the default Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-BTProject -Default makes the Project the default for the Session.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-BTProject</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</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> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the default Project for the Session.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</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> <!-- Parameter: Default --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the default Project for the Session.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project identity: ProjectId, ProjectName, or Project object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Project --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Project</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-BTProject -Identity 986 -Default</maml:para> <maml:para>Set-BTProject -Identity 'My Project' -Default</maml:para> <maml:para>Set-BTProject -Identity $project -Default</maml:para> <maml:para>Sets the default Project by ProjectId, ProjectName, or a Project object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTServiceAccount --> <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-BTServiceAccount</command:name> <command:verb>Get</command:verb> <command:noun>BTServiceAccount</command:noun> <maml:description> <maml:para>Returns Power365 ServiceAccounts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTServiceAccount -Identity returns the Power365 ServiceAccount identified by its Id, PrincipalName, or a ServiceAccount object.</maml:para> <maml:para>Get-BTServiceAccount [-Type] [-Filter] [-Limit] returns Power365 ServiceAccounts matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTServiceAccount cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTServiceAccount</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTServiceAccount</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PrincipalName -like '*123*'". The supported properties are Id, PrincipalName, and EnvironmentName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PrincipalName -like '*123*'". The supported properties are Id, PrincipalName, and EnvironmentName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServiceAccount --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ServiceAccount</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-BTServiceAccount -Identity 153</maml:para> <maml:para>Get-BTServiceAccount -Identity BTPowerShellUser.123@contoso.com</maml:para> <maml:para>Get-BTServiceAccount -Identity $serviceAccount</maml:para> <maml:para>Returns a Power365 ServiceAccount by id, identity, or a ServiceAccount object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTServiceAccount</maml:para> <maml:para>Returns all Power365 ServiceAccounts.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTServiceAccount -Filter "PrincipalName -like '*123*'" -Limit 10</maml:para> <maml:para>Returns the first 10 Power365 ServiceAccounts whose PrincipalName matches the pattern.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTServiceAccount --> <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-BTServiceAccount</command:name> <command:verb>Set</command:verb> <command:noun>BTServiceAccount</command:noun> <maml:description> <maml:para>Updates a Power365 ServiceAccount.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-BTServiceAccount -Password sets a Power365 ServiceAccount's password.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Set-BTServiceAccount cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-BTServiceAccount</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</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> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>New password.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</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> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>New password.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Power365 ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServiceAccount --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ServiceAccount</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-BTServiceAccount -Identity BTPowerShellUser.123@contoso.com -Password $secureString</maml:para> <maml:para>Set-BTServiceAccount -Identity 153 -Password $secureString</maml:para> <maml:para>Sets the specified Power365 ServiceAccount's password.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Connect-BTSession --> <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>Connect-BTSession</command:name> <command:verb>Connect</command:verb> <command:noun>BTSession</command:noun> <maml:description> <maml:para>Connects to a Power365 instance. The Power365 Session remains the default until Connect-BTSession is invoked again, or -Session is specified on a cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Connect-BTSession connects to a Power365 instance.</maml:para> <maml:para>This requires an ApiKey issued by an administrator of your Power365 account.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Connect --> <command:syntaxItem> <maml:name>Connect-BTSession</maml:name> <!-- Parameter: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>The API Key issued by an administrator of your Power365 account.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>The API Key issued by an administrator of your Power365 account.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Session --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>$secureKey = Read-Host 'What is your ApiKey?' -AsSecureString</maml:para> <maml:para>Connect-BTSession -ApiKey $secureKey</maml:para> <maml:para>Returns the Power365 Session.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disconnect-BTSession --> <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>Disconnect-BTSession</command:name> <command:verb>Disconnect</command:verb> <command:noun>BTSession</command:noun> <maml:description> <maml:para>Disconnects from a Power365 instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disconnect-BTSession disconnects from a Power365 instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disconnect-BTSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Disonnect-BTSession</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTSession --> <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-BTSession</command:name> <command:verb>Get</command:verb> <command:noun>BTSession</command:noun> <maml:description> <maml:para>Gets the default Power365 Session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTSession gets the default Power365 Session.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-BTSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: Session --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</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-BTSession</maml:para> <maml:para>Returns the default Power365 Session.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTSync --> <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-BTSync</command:name> <command:verb>Get</command:verb> <command:noun>BTSync</command:noun> <maml:description> <maml:para>Returns the statuses of Power365 Sync operations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTSync -Identity returns the Sync identified by its SyncJobId, or a Sync object.</maml:para> <maml:para>Get-BTSync [-Project] [-Wave] [-User] [-Filter] [-Limit] returns Syncs matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTSync</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Sync identity: SyncJobId, or Sync object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTSync</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are SyncJobId, UserId, SyncDataType, SyncState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</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> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Sync identity: SyncJobId, or Sync object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</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> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Filter by User, specified by UserId, UPN, Email, or User object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PercentComplete -eq 100". The supported properties are SyncJobId, UserId, SyncDataType, SyncState, IsComplete, Started, Completed, PercentComplete, and TotalTimeSeconds.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Sync identity: SyncJobId, or Sync object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SyncJob --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncJob</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-BTSync -Identity 986</maml:para> <maml:para>Get-BTSync -Identity $sync</maml:para> <maml:para>Returns a Sync by SyncJobId, or a Sync object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTSync</maml:para> <maml:para>Returns all Syncs.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTSync -User joe@contoso.com -Filter "IsComplete -eq true" -Limit 10</maml:para> <maml:para>Returns the most recent 10 Syncs for the specified User where IsComplete is true.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTSync --> <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-BTSync</command:name> <command:verb>Start</command:verb> <command:noun>BTSync</command:noun> <maml:description> <maml:para>Start Sync operations for Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Start-BTSync -User starts a Sync operation for a User.</maml:para> <maml:para>Start-BTSync -Wave starts a Sync operation for a Wave.</maml:para> <maml:para>Start-BTSync -InputObject starts a Sync operation for a User or Wave.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTSync cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByUser --> <command:syntaxItem> <maml:name>Start-BTSync</maml:name> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByWave --> <command:syntaxItem> <maml:name>Start-BTSync</maml:name> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInputObject --> <command:syntaxItem> <maml:name>Start-BTSync</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or User object.</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> <!-- Parameter: Wave --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or Wave object.</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> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The User or Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The User or Wave object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTSync -User 356</maml:para> <maml:para>Start-BTSync -User joe@contoso.com</maml:para> <maml:para>Start-BTSync -User $user</maml:para> <maml:para>Starts a Sync for a User by id, identity, or User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Start-BTSync -Wave 356</maml:para> <maml:para>Start-BTSync -Wave 'My Wave'</maml:para> <maml:para>Start-BTSync -Wave $wave</maml:para> <maml:para>Starts a Sync for a Wave by id, identity, or Wave object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>$usersOrWaves | Start-BTSync</maml:para> <maml:para>Starts a Sync for each input object, which can be a User or a Wave object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTUnregisteredDevice --> <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-BTUnregisteredDevice</command:name> <command:verb>Get</command:verb> <command:noun>BTUnregisteredDevice</command:noun> <maml:description> <maml:para>Returns the UnregisteredDevices.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTUnregisteredDevice -Identity returns the UnregisteredDevice identified by its UnregisteredDeviceId, identity, or a UnregisteredDevice object.</maml:para> <maml:para>Get-BTUnregisteredDevice [-Filter] [-Limit] returns UnregisteredDevices matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTUnregisteredDevice cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTUnregisteredDevice</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>UnregisteredDevice identity: UnregisteredDeviceId, Name, or a UnregisteredDevice object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTUnregisteredDevice</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are UnregisteredDeviceId Name, DistinguishedName and IsPendingRemoval.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>UnregisteredDevice identity: UnregisteredDeviceId, Name, or a UnregisteredDevice object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are UnregisteredDeviceId Name, DistinguishedName and IsPendingRemoval.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>UnregisteredDevice identity: UnregisteredDeviceId, Name, or a UnregisteredDevice object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: UnregisteredDevice --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UnregisteredDevice</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-BTUnregisteredDevice -Identity 986</maml:para> <maml:para>Get-BTUnregisteredDevice -Identity 'My UnregisteredDevice Name'</maml:para> <maml:para>Get-BTUnregisteredDevice -Identity $UnregisteredDevice</maml:para> <maml:para>Returns a UnregisteredDevice by UnregisteredDeviceId, identity, or a UnregisteredDevice object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTUnregisteredDevice</maml:para> <maml:para>Returns all UnregisteredDevices.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTUnregisteredDevice -Filter "Name -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 UnregisteredDevices whose Name starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTUser --> <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-BTUser</command:name> <command:verb>Get</command:verb> <command:noun>BTUser</command:noun> <maml:description> <maml:para>Returns Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTUser -Identity returns the User identified by its UserId, identity, or a User object.</maml:para> <maml:para>Get-BTUser [-Filter] [-Limit] [-Project] [-Wave] returns Users matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTUser cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTUser</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTUser</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties are ArchiveSize, DeliverToMailboxAndForward, Department, DisplayName, ErsRewriteGroup, ErsRewriteMode, HiddenFromAddressListsEnabled, IsContact, IsEquipment, IsMailbox, IsMailUser, IsRoom, IsShared, IsTeam, IsUnifiedGroup, Mail, MailNickname, MigrationState, ProfileId, ProfileName, LitigationHoldDate, LitigationHoldDuration, LitigationHoldEnabled, LitigationHoldOwner, MailboxServicePlan, MailboxSize, MatchReason, NewPrimarySmtpAddress, NewUserPrincipalName, OdbQuota, OdbServicePlan, OdbSize, OnPremisesSamAccountName, OnPremisesUserPrincipalName, OutlookState, PercentComplete, PreferredLanguage, ProjectId, ProjectName, RecipientType, RecipientTypeDetails, Region, SamAccountName, TargetMail, TargetMailNickname, TargetSamAccountName, TargetTenantId, TargetTenantName, TargetUserPrincipalName, TenantId, TenantName, Uid, UserId, UserPrincipalName, WaveId, and WaveName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Filter by Profile, specified by ProfileId, ProfileName, or Profile object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>Filter by Wave, specified by WaveId, WaveName, or Wave object.</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> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Filter by Profile, specified by ProfileId, ProfileName, or Profile object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties are ArchiveSize, DeliverToMailboxAndForward, Department, DisplayName, ErsRewriteGroup, ErsRewriteMode, HiddenFromAddressListsEnabled, IsContact, IsEquipment, IsMailbox, IsMailUser, IsRoom, IsShared, IsTeam, IsUnifiedGroup, Mail, MailNickname, MigrationState, ProfileId, ProfileName, LitigationHoldDate, LitigationHoldDuration, LitigationHoldEnabled, LitigationHoldOwner, MailboxServicePlan, MailboxSize, MatchReason, NewPrimarySmtpAddress, NewUserPrincipalName, OdbQuota, OdbServicePlan, OdbSize, OnPremisesSamAccountName, OnPremisesUserPrincipalName, OutlookState, PercentComplete, PreferredLanguage, ProjectId, ProjectName, RecipientType, RecipientTypeDetails, Region, SamAccountName, TargetMail, TargetMailNickname, TargetSamAccountName, TargetTenantId, TargetTenantName, TargetUserPrincipalName, TenantId, TenantName, Uid, UserId, UserPrincipalName, WaveId, and WaveName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: User --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.User</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-BTUser -Identity 153</maml:para> <maml:para>Get-BTUser -Identity bob.smith@contoso.com</maml:para> <maml:para>Get-BTUser -Identity 'Bob Smith'</maml:para> <maml:para>Get-BTUser -Identity $user</maml:para> <maml:para>Returns a User by UserId, identity, or a User object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTUser</maml:para> <maml:para>Returns all Users.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTUser -Wave 'My Wave' -Filter "MigrationState -eq 'Ready'" -Limit 10</maml:para> <maml:para>Returns the first 10 Users in the specified Wave where MigrationState is Ready.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-BTUser --> <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-BTUser</command:name> <command:verb>Set</command:verb> <command:noun>BTUser</command:noun> <maml:description> <maml:para>Updates Power365 Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-BTUser -Identity -Wave sets or clears a User's Wave.</maml:para> <maml:para>Set-BTUser -Identity -Profile sets a User's Profile.</maml:para> <maml:para>Set-BTUser -Identity -MatchIdentity sets or clears a User's matching target object.</maml:para> <maml:para>Set-BTUser -Identity -MigrationState updates a User's migration state.</maml:para> <maml:para>Set-BTUser -MatchProperty sets or clears multiple Users' matching target objects.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Set-BTUser cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-BTUser</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</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> <!-- Parameter: MatchIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchIdentity</maml:name> <maml:description> <maml:para>Identity of matching target user: To set the matching user, specify the UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object. To clear the matching user, specify $null or an empty string. Cannot be used with pipeline input.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~NotSpecified~</dev:defaultValue> </command:parameter> <!-- Parameter: MatchProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchProperty</maml:name> <maml:description> <maml:para>Property of input object that contains the identity of the matching target user. Can be used with pipeline input. To clear the matching user, specify "None", or specify a property of the input object whose value is an empty string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~NotSpecified~</dev:defaultValue> </command:parameter> <!-- Parameter: MigrationState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MigrationState</maml:name> <maml:description> <maml:para>New migration state.</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: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>New Profile.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit identity searches to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any. Ignored if -Identity is a UserId or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>New Wave, or $null to remove the user from its current Wave.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit identity searches to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any. Ignored if -Identity is a UserId or User object.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Wave --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wave</maml:name> <maml:description> <maml:para>New Wave, or $null to remove the user from its current Wave.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>New Profile.</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> <!-- Parameter: MigrationState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MigrationState</maml:name> <maml:description> <maml:para>New migration state.</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: MatchIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchIdentity</maml:name> <maml:description> <maml:para>Identity of matching target user: To set the matching user, specify the UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object. To clear the matching user, specify $null or an empty string. Cannot be used with pipeline input.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~NotSpecified~</dev:defaultValue> </command:parameter> <!-- Parameter: MatchProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchProperty</maml:name> <maml:description> <maml:para>Property of input object that contains the identity of the matching target user. Can be used with pipeline input. To clear the matching user, specify "None", or specify a property of the input object whose value is an empty string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>~NotSpecified~</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User identity: UserId, Uid, SamAccountName, Mail, UserPrincipalName, DisplayName, or a User object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: User --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.User</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-BTUser -Identity bob.smith@contoso.com -Wave 83</maml:para> <maml:para>Set-BTUser -Identity 'Bob Smith' -Wave 'My Wave'</maml:para> <maml:para>Set-BTUser -Identity 983 -Wave $wave</maml:para> <maml:para>Set-BTUser -Identity $user -Wave $null</maml:para> <maml:para>Sets or clears the specified User's Wave.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -Profile 906</maml:para> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -Profile 'My Profile'</maml:para> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -Profile $profile</maml:para> <maml:para>Sets the specified User's Profile.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -MigrationState Complete</maml:para> <maml:para>Sets the specified User's migration state.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -MatchIdentity bob.smith@fabrikam.com</maml:para> <maml:para>Sets the specified User's matching target object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <maml:introduction> <maml:para>Set-BTUser -Identity bob.smith@contoso.com -MatchIdentity $null</maml:para> <maml:para>Clears the specified User's matching target object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <maml:introduction> <maml:para>Import-CSV <path> | Set-BTUser -MatchProperty TargetUserPrincipalName</maml:para> <maml:para>Sets the specified Users' matching target objects using a column from a .csv file.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <maml:introduction> <maml:para>Import-CSV <path> | Set-BTUser -MatchProperty None</maml:para> <maml:para>Clears the specified Users' matching target objects using a .csv file.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTWave --> <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-BTWave</command:name> <command:verb>Get</command:verb> <command:noun>BTWave</command:noun> <maml:description> <maml:para>Returns Power365 Waves.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTWave -Identity returns the Wave identified by its WaveId, WaveName, or a Wave object.</maml:para> <maml:para>Get-BTWave [-Project] [-Filter] [-Limit] returns Waves matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWave cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTWave</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or a Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTWave</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WaveName -like 'My*'". The supported properties are AdGroupName, AdGroupUid, CompleteUsers, ErrorUsers, InProgressUsers, NotReadyUsers, OtherUsers, ProjectId, ProjectName, ReadyUsers, RollbackUsers, TenantMigrationId, TotalUsers, WaveId, and WaveName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or a Wave object.</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> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WaveName -like 'My*'". The supported properties are AdGroupName, AdGroupUid, CompleteUsers, ErrorUsers, InProgressUsers, NotReadyUsers, OtherUsers, ProjectId, ProjectName, ReadyUsers, RollbackUsers, TenantMigrationId, TotalUsers, WaveId, and WaveName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Wave identity: WaveId, WaveName, or a Wave object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Wave --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Wave</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-BTWave -Identity 986</maml:para> <maml:para>Get-BTWave -Identity 'My Wave'</maml:para> <maml:para>Get-BTWave -Identity $wave</maml:para> <maml:para>Returns a Wave by WaveId, WaveName, or a Wave object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWave</maml:para> <maml:para>Returns all Waves.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWave -Filter "WaveName -like 'M*'" -Limit 10</maml:para> <maml:para>Returns the first 10 Waves whose WaveName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-BTWave --> <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-BTWave</command:name> <command:verb>New</command:verb> <command:noun>BTWave</command:noun> <maml:description> <maml:para>Creates a new Power365 Wave.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The ApiKey role must be 'Writer' to run the New-BTWave cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-BTWave</maml:name> <!-- Parameter: WaveName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WaveName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WaveName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WaveName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Wave --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.Wave</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-BTWave -DisplayName 'My Wave'</maml:para> <maml:para>Creates a new Wave with the specified name.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTWorkflow --> <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-BTWorkflow</command:name> <command:verb>Get</command:verb> <command:noun>BTWorkflow</command:noun> <maml:description> <maml:para>(Deprecated. Use Get-DSWorkflow) Returns Power365 Workflows.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-BTWorkflow -Identity returns a Workflow by WorkflowId, identity, or a Workflow object.</maml:para> <maml:para>Get-BTWorkflow [-Filter] [-Limit] returns Workflows that match selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWorkflow cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTWorkflow</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Workflow identity: WorkflowId, Name, or a Workflow object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTWorkflow</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are WorkflowId and 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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Workflow identity: WorkflowId, Name, or a Workflow object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are WorkflowId and 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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Workflow identity: WorkflowId, Name, or a Workflow object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSWorkflow --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSWorkflow</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-BTWorkflow -Identity 107</maml:para> <maml:para>Get-BTWorkflow -Identity 'My Workflow'</maml:para> <maml:para>Get-BTWorkflow -Identity $workflow</maml:para> <maml:para>Returns a Workflow by WorkflowId, identity, or a Workflow object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWorkflow</maml:para> <maml:para>Returns all Workflows.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-BTWorkflow -Filter "Name -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 Workflows whose Name starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-BTWorkflow --> <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-BTWorkflow</command:name> <command:verb>Start</command:verb> <command:noun>BTWorkflow</command:noun> <maml:description> <maml:para>(Deprecated. Use Start-DSWorkflow) Start a Power365 Workflow.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Start-BTWorkflow -Identity Workflow (by object or id) cmdlet starts the specified Workflow.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-BTWorkflow cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-BTWorkflow</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the identity (as a Workflow object or id) of a Workflow to start.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the identity (as a Workflow object or id) of a Workflow to start.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the identity (as a Workflow object or id) of a Workflow to start.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSWorkflow --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSWorkflow</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-BTWorkflow -Identity 4296</maml:para> <maml:para>Start a Workflow.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTWorkflowLog --> <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-BTWorkflowLog</command:name> <command:verb>Get</command:verb> <command:noun>BTWorkflowLog</command:noun> <maml:description> <maml:para>(Depricated:Use Get-DSWorkflowLog) Returns the Logs for a specified Power365 WorkflowRun.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-BTWorkflowLog -Identity (WorkflowRun object or id) cmdlet matches only one identity.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWorkflowLog cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-BTWorkflowLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: WorkflowRunId or WorkflowRun object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Level -eq 'Error'". The supported properties are JobLogId, Level, TimeStamp, Message, and AgentId.</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: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: WorkflowRunId or WorkflowRun object.</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> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Level -eq 'Error'". The supported properties are JobLogId, Level, TimeStamp, Message, and AgentId.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</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-BTWorkFlowLog -Identity 4926 -Limit 10</maml:para> <maml:para>Returns the most recent 10 Logs for WorkflowRun 4926.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-BTWorkflowRun --> <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-BTWorkflowRun</command:name> <command:verb>Get</command:verb> <command:noun>BTWorkflowRun</command:noun> <maml:description> <maml:para>(Depricated:Use Get-DSWorkflowRun) Returns Power365 WorkflowRuns.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-WorkflowRun -Identity returns a WorkflowRun by WorkflowRunId or a WorkflowRun object.</maml:para> <maml:para>Get-WorkflowRun [-Filter] [-Limit] [-Workflow] returns WorkflowRuns that match selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-WorkflowRun cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-BTWorkflowRun</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>WorkflowRun identity: WorkflowRunId or WorkflowRun object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-BTWorkflowRun</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WorkflowName -like 'My*'". The supported properties are WorkflowRunId, WorkflowId, and WorkflowName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Filter by Workflow (WorkflowId, Name, or Workflow object).</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>WorkflowRun identity: WorkflowRunId or WorkflowRun object.</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> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Filter by Workflow (WorkflowId, Name, or Workflow object).</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WorkflowName -like 'My*'". The supported properties are WorkflowRunId, WorkflowId, and WorkflowName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>WorkflowRun identity: WorkflowRunId or WorkflowRun object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSWorkflowRun --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSWorkflowRun</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-WorkflowRun -Identity 766</maml:para> <maml:para>Get-WorkflowRun -Identity $workflowRun</maml:para> <maml:para>Gets a WorkflowRun by WorkflowRunId or WorkflowRun object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-WorkflowRun</maml:para> <maml:para>Returns all WorkflowRuns.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-WorkflowRun -Filter "WorkflowName -like 'M*'" -Limit 5</maml:para> <maml:para>Returns the 5 most recent WorkflowRuns for Workflows whose names start with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DSEnvironment --> <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-DSEnvironment</command:name> <command:verb>Get</command:verb> <command:noun>DSEnvironment</command:noun> <maml:description> <maml:para>Returns CDS Environments.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-DSEnvironment -Identity returns an Environment by id, or an Environment object.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-DSEnvironment cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-DSEnvironment</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: EnvironmentId, or an Environment object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-DSEnvironment</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: EndpointType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndpointType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are WorkflowId and 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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Schedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Environment identity: EnvironmentId, or an Environment object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are WorkflowId and 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: EndpointType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndpointType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Schedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Environment identity: EnvironmentId, or an Environment object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSEndpoint --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSEndpoint</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-DSEnvironment -Identity 107</maml:para> <maml:para>Get-DSEnvironment -Identity $Environment</maml:para> <maml:para>Returns an Environment by EnvironmentId, or an Environment object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-DSEnvironment</maml:para> <maml:para>Returns all Environments.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSEnvironment --> <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-DSEnvironment</command:name> <command:verb>Set</command:verb> <command:noun>DSEnvironment</command:noun> <maml:description> <maml:para>Set CDS Environment's parameter values.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSEnvironment -Identity Environment (by object or id) cmdlet set the specified Environment's parameters.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-DSEnvironment cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSEnvironment</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Environment, specified by Environment object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: AllowPasswordChanges --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowPasswordChanges</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContactAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContactAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceFilterEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceFilterEnabled</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Discovery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Discovery</maml:name> <maml:description> <maml:para>Possible values: Pending, Discovering, Discovered, DiscoveryFailed</maml:para> </maml:description> <command:parameterValue required="true">DiscoveryStatus</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DiscoveryStatus</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Pending</command:parameterValue> <command:parameterValue required="false" variableLength="false">Discovering</command:parameterValue> <command:parameterValue required="false" variableLength="false">Discovered</command:parameterValue> <command:parameterValue required="false" variableLength="false">DiscoveryFailed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DiscoverySchedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoverySchedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeDisabledAccounts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeDisabledAccounts</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeExpiredAccounts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeExpiredAccounts</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeWellKnownObjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeWellKnownObjects</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterGroups</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GlobalFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GlobalFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GlobalFilterEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GlobalFilterEnabled</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupFilterEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupFilterEnabled</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeDirSynced --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDirSynced</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup, AllUnifiedGroup, AllOnPremUser, AllOnPremGroup, AllOnPremDevice, AllOnPrem, AllCloudUser, AllCloudSecurityGroup, AllCloudGroup, AllCloudDevice, AllCloud</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypesExtended</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypesExtended</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllUnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllOnPremUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllOnPremGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllOnPremDevice</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllOnPrem</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloudUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloudSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloudGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloudDevice</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloud</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsDiscovered --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsDiscovered</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LastDiscovery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastDiscovery</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LastPushedDeltaTokensJson --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastPushedDeltaTokensJson</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LastPushedWhenChanged --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastPushedWhenChanged</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LdapFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LdapFilter</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxPowerShellResultSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxPowerShellResultSize</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReconcileOnHoursSinceLastReconcile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReconcileOnHoursSinceLastReconcile</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReconcileOnNextPush --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReconcileOnNextPush</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserFilterEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserFilterEnabled</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Workflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflows</maml:name> <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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Environment, specified by Environment object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Discovery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Discovery</maml:name> <maml:description> <maml:para>Possible values: Pending, Discovering, Discovered, DiscoveryFailed</maml:para> </maml:description> <command:parameterValue required="true">DiscoveryStatus</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DiscoveryStatus</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Pending</command:parameterValue> <command:parameterValue required="false" variableLength="false">Discovering</command:parameterValue> <command:parameterValue required="false" variableLength="false">Discovered</command:parameterValue> <command:parameterValue required="false" variableLength="false">DiscoveryFailed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LastDiscovery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastDiscovery</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContactAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContactAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GlobalFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GlobalFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GlobalFilterEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GlobalFilterEnabled</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserFilterEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserFilterEnabled</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupFilterEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupFilterEnabled</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeviceFilterEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceFilterEnabled</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReconcileOnNextPush --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReconcileOnNextPush</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiscoverySchedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiscoverySchedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReconcileOnHoursSinceLastReconcile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReconcileOnHoursSinceLastReconcile</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsDiscovered --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsDiscovered</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup, AllUnifiedGroup, AllOnPremUser, AllOnPremGroup, AllOnPremDevice, AllOnPrem, AllCloudUser, AllCloudSecurityGroup, AllCloudGroup, AllCloudDevice, AllCloud</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypesExtended</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypesExtended</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllUnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllOnPremUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllOnPremGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllOnPremDevice</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllOnPrem</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloudUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloudSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloudGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloudDevice</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllCloud</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ExcludeWellKnownObjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeWellKnownObjects</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeDisabledAccounts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeDisabledAccounts</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeExpiredAccounts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeExpiredAccounts</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LdapFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LdapFilter</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllowPasswordChanges --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowPasswordChanges</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LastPushedWhenChanged --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastPushedWhenChanged</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LastPushedDeltaTokensJson --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastPushedDeltaTokensJson</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxPowerShellResultSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxPowerShellResultSize</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeDirSynced --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDirSynced</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Workflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflows</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterGroups</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Environment, specified by Environment object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSEndpoint --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSEndpoint</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-DSEnvironment -Identity Environment -EnvironmentType:Base -DayOfWeek day -Time time</maml:para> <maml:para>Changed Environment.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSFilter --> <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-DSFilter</command:name> <command:verb>New</command:verb> <command:noun>DSFilter</command:noun> <maml:description> <maml:para>Create a CDS Filter object in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSFilter -Identity Filter (by object or id) cmdlet creates the specified Filter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSFilter</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Create a new Filter object.</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> <!-- Parameter: ClauseType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ClauseType</maml:name> <maml:description> <maml:para>Possible values: Unknown, And, Or</maml:para> </maml:description> <command:parameterValue required="true">ClauseType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ClauseType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" variableLength="false">And</command:parameterValue> <command:parameterValue required="false" variableLength="false">Or</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Children --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Children</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterClauses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterClauses</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Parent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Parent</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Create a new Filter object.</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> <!-- Parameter: Parent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Parent</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClauseType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ClauseType</maml:name> <maml:description> <maml:para>Possible values: Unknown, And, Or</maml:para> </maml:description> <command:parameterValue required="true">ClauseType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ClauseType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" variableLength="false">And</command:parameterValue> <command:parameterValue required="false" variableLength="false">Or</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FilterClauses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterClauses</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Children --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Children</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Create a new Filter object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSFilter --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilter</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSFilter -Identity filter -Parent parent -ClauseType clauseType</maml:para> <maml:para>New Filter object.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSFilter --> <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-DSFilter</command:name> <command:verb>Set</command:verb> <command:noun>DSFilter</command:noun> <maml:description> <maml:para>Set CDS Filter's parameter values in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSFilter -Identity Filter (by object or id) cmdlet set the specified Filter's parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSFilter</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Filter, specified by Filter object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSFilter</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilter</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Children --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Children</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClauseType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClauseType</maml:name> <maml:description> <maml:para>Possible values: Unknown, And, Or</maml:para> </maml:description> <command:parameterValue required="true">ClauseType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ClauseType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" variableLength="false">And</command:parameterValue> <command:parameterValue required="false" variableLength="false">Or</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FilterClauses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterClauses</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Parent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Parent</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Filter, specified by Filter object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSFilter</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilter</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Parent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Parent</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClauseType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClauseType</maml:name> <maml:description> <maml:para>Possible values: Unknown, And, Or</maml:para> </maml:description> <command:parameterValue required="true">ClauseType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ClauseType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" variableLength="false">And</command:parameterValue> <command:parameterValue required="false" variableLength="false">Or</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Children --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Children</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterClauses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterClauses</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Filter, specified by Filter object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSFilter --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilter</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-DSFilter -Identity filter -Parent parent -Profile profile -ActionType actionType -Test test -ClauseType clauseType</maml:para> <maml:para>Changed Filter.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSFilterClause --> <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-DSFilterClause</command:name> <command:verb>New</command:verb> <command:noun>DSFilterClause</command:noun> <maml:description> <maml:para>Create a CDS FilterClause object in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSFilterClause -Identity FilterClause (by object or id) cmdlet creates a new FilterClause.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSFilterClause</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Add a new FilterClause object.</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> <!-- Parameter: ActionType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Possible values: Equal, NotEqual, GreaterThanOrEqual, LessThanOrEqual, StartsWith, EndsWith, Contains</maml:para> </maml:description> <command:parameterValue required="true">ActionType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ActionType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Equal</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">StartsWith</command:parameterValue> <command:parameterValue required="false" variableLength="false">EndsWith</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contains</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Attribute --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Attribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Test --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Test</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClauseType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClauseType</maml:name> <maml:description> <maml:para>Possible values: Unknown, And, Or</maml:para> </maml:description> <command:parameterValue required="true">ClauseType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ClauseType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unknown</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" variableLength="false">And</command:parameterValue> <command:parameterValue required="false" variableLength="false">Or</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Add a new FilterClause object.</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> <!-- Parameter: Attribute --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Attribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActionType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Possible values: Equal, NotEqual, GreaterThanOrEqual, LessThanOrEqual, StartsWith, EndsWith, Contains</maml:para> </maml:description> <command:parameterValue required="true">ActionType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ActionType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Equal</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">StartsWith</command:parameterValue> <command:parameterValue required="false" variableLength="false">EndsWith</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contains</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Test --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Test</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClauseType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClauseType</maml:name> <maml:description> <maml:para>Possible values: Unknown, And, Or</maml:para> </maml:description> <command:parameterValue required="true">ClauseType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ClauseType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unknown</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" variableLength="false">And</command:parameterValue> <command:parameterValue required="false" variableLength="false">Or</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Add a new FilterClause object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSFilterClause --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilterClause</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSFilterClause -Identity filterClause -Filter filterId -Attribute attributeId -ActionType actionType -Test test -ClauseType clauseType</maml:para> <maml:para>New FilterClause.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSFilterClause --> <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-DSFilterClause</command:name> <command:verb>Set</command:verb> <command:noun>DSFilterClause</command:noun> <maml:description> <maml:para>Set CDS FilterClause's parameter values in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSFilterClause -Identity FilterClause (by object or id) cmdlet set the specified FilterClause's parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSFilterClause</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this FilterClause, specified by FilterClause object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSFilterClause</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilterClause</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClauseType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ClauseType</maml:name> <maml:description> <maml:para>Possible values: Unknown, And, Or</maml:para> </maml:description> <command:parameterValue required="true">ClauseType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ClauseType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" variableLength="false">And</command:parameterValue> <command:parameterValue required="false" variableLength="false">Or</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ActionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Possible values: Equal, NotEqual, GreaterThanOrEqual, LessThanOrEqual, StartsWith, EndsWith, Contains</maml:para> </maml:description> <command:parameterValue required="true">ActionType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ActionType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Equal</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">StartsWith</command:parameterValue> <command:parameterValue required="false" variableLength="false">EndsWith</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contains</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Attribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Attribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Test --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Test</maml:name> <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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this FilterClause, specified by FilterClause object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSFilterClause</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilterClause</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Attribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Attribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Possible values: Equal, NotEqual, GreaterThanOrEqual, LessThanOrEqual, StartsWith, EndsWith, Contains</maml:para> </maml:description> <command:parameterValue required="true">ActionType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ActionType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Equal</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">StartsWith</command:parameterValue> <command:parameterValue required="false" variableLength="false">EndsWith</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contains</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Test --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Test</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClauseType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ClauseType</maml:name> <maml:description> <maml:para>Possible values: Unknown, And, Or</maml:para> </maml:description> <command:parameterValue required="true">ClauseType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ClauseType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" variableLength="false">And</command:parameterValue> <command:parameterValue required="false" variableLength="false">Or</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilterClause</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this FilterClause, specified by FilterClause object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSFilterClause --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilterClause</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-DSFilterClause -Identity filterClause -Filter filterId -Attribute attributeId -ActionType actionType -Test test -ClauseType clauseType</maml:para> <maml:para>Changed FilterClause.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DSFilterGroup --> <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-DSFilterGroup</command:name> <command:verb>Get</command:verb> <command:noun>DSFilterGroup</command:noun> <maml:description> <maml:para>Returns the DSFilterGroups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-DSFilterGroup -Identity returns the DSFilterGroup identified by its FilterGroupId, identity, or a DSFilterGroup object.</maml:para> <maml:para>Get-DSFilterGroup [-Filter] [-Limit] returns DSFilterGroups matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-DSFilterGroup cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-DSFilterGroup</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DSFilterGroup identity: FilterGroupId, ObjectId, or a DSFilterGroup object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-DSFilterGroup</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ObjectId -like 'My*'". The supported properties are FilterGroupId, EndpointId, ObjectId, DisplayName and Mail.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DSFilterGroup identity: FilterGroupId, ObjectId, or a DSFilterGroup object.</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> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "ObjectId -like 'My*'". The supported properties are FilterGroupId, EndpointId, ObjectId, DisplayName and Mail.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>True for expanded properties.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DSFilterGroup identity: FilterGroupId, ObjectId, or a DSFilterGroup object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSFilterGroup --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilterGroup</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-DSFilterGroup -Identity 986</maml:para> <maml:para>Get-DSFilterGroup -Identity 'My DSFilterGroup ObjectId'</maml:para> <maml:para>Get-DSFilterGroup -Identity $DSFilterGroup</maml:para> <maml:para>Returns a DSFilterGroup by FilterGroupId, identity, or a DSFilterGroup object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-DSFilterGroup</maml:para> <maml:para>Returns all DSFilterGroups.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-DSFilterGroup -Filter "DisplayName -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 DSFilterGroups whose DisplayName starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSFilterGroup --> <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-DSFilterGroup</command:name> <command:verb>New</command:verb> <command:noun>DSFilterGroup</command:noun> <maml:description> <maml:para>Create a new DSFilterGroup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSFilterGroup -Identity DSFilterGroup (by object) cmdlet creates the specified DSFilterGroup.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-DSFilterGroup cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSFilterGroup</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DSFilterGroup Identity (object). If specified, Identity object will be used to create the new DSFilterGroup and other parameters will be ignored.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BySpecificValues --> <command:syntaxItem> <maml:name>New-DSFilterGroup</maml:name> <!-- Parameter: DisplayName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The Display Name of the Group</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: Environment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The Endpoint of DSFilterGroup (object or id)</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> <!-- Parameter: Mail --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mail</maml:name> <maml:description> <maml:para>The Mail of the Group</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: ObjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the Group in AzureAD</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DSFilterGroup Identity (object). If specified, Identity object will be used to create the new DSFilterGroup and other parameters will be ignored.</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> <!-- Parameter: Environment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The Endpoint of DSFilterGroup (object or id)</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> <!-- Parameter: ObjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the Group in AzureAD</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The Display Name of the Group</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: Mail --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Mail</maml:name> <maml:description> <maml:para>The Mail of the Group</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DSFilterGroup Identity (object). If specified, Identity object will be used to create the new DSFilterGroup and other parameters will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSFilterGroup --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilterGroup</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSFilterGroup -Endpoint 1 -ObjectId ObjectId -DisplayName Name -Mail Mail</maml:para> <maml:para>Creates a new DSFilterGroup.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSFilterGroup --> <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-DSFilterGroup</command:name> <command:verb>Set</command:verb> <command:noun>DSFilterGroup</command:noun> <maml:description> <maml:para>Set new property values in a DSFilterGroup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSFilterGroup -Identity DSFilterGroup (by object or id) cmdlet sets properties in the specified DSFilterGroup.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-DSFilterGroup cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSFilterGroup</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DSFilterGroup identity: FilterGroupId or a DSFilterGroup object.</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> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The Display Name of the Group</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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The Endpoint of DSFilterGroup (object or id)</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> <!-- Parameter: Mail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mail</maml:name> <maml:description> <maml:para>The Mail of the Group</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: ObjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the Group in AzureAD</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DSFilterGroup identity: FilterGroupId or a DSFilterGroup object.</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> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The Endpoint of DSFilterGroup (object or id)</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> <!-- Parameter: ObjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the Group in AzureAD</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="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The Display Name of the Group</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: Mail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mail</maml:name> <maml:description> <maml:para>The Mail of the Group</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DSFilterGroup identity: FilterGroupId or a DSFilterGroup object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSFilterGroup --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSFilterGroup</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-DSFilterGroup -Identity 25 -ObjectId "new value"</maml:para> <maml:para>Set a DSFilterGroup ObjectId property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSMapping --> <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-DSMapping</command:name> <command:verb>New</command:verb> <command:noun>DSMapping</command:noun> <maml:description> <maml:para>Create a new CDS Mapping.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSMapping -Identity Mapping (by object or id) cmdlet creates the specified Mapping.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Add-DSMapping cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSMapping</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Add a new Mapping object.</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> <!-- Parameter: Expression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsAllowedExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAllowedExpression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAttribute</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Locked --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locked</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <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: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Add a new Mapping object.</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> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAttribute</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IsAllowedExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAllowedExpression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Locked --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locked</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Add a new Mapping object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSMapping --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMapping</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSMapping -Identity mapping -MatchAcrossAddressTypes $true -MatchOnAgent $false</maml:para> <maml:para>Create a new Mapping.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSMapping --> <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-DSMapping</command:name> <command:verb>Set</command:verb> <command:noun>DSMapping</command:noun> <maml:description> <maml:para>Set CDS Mapping's parameter values in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSMapping -Identity mapping -MatchAcrossAddressTypes $true -MatchOnAgent $false</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSMapping</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Mapping, specified by Mapping object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSMapping</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMapping</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsAllowedExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAllowedExpression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAttribute</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locked --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locked</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Mapping, specified by Mapping object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSMapping</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMapping</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAttribute</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsAllowedExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsAllowedExpression</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Locked --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locked</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMapping</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Mapping, specified by Mapping object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSMapping --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMapping</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-DSMapping -Identity mapping -MatchAcrossAddressTypes $true -MatchOnAgent $false</maml:para> <maml:para>Changed Mapping.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSMatching --> <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-DSMatching</command:name> <command:verb>New</command:verb> <command:noun>DSMatching</command:noun> <maml:description> <maml:para>Create a CDS Matching object in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSMatching -Identity Matching (by object or id) cmdlet adds the specified Matching.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSMatching</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Add a new Matching object.</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> <!-- Parameter: MatchAcrossObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchAcrossObjectTypes</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchOnAgent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchOnAgent</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchRules</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Add a new Matching object.</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> <!-- Parameter: MatchAcrossObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchAcrossObjectTypes</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchOnAgent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchOnAgent</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchRules</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Add a new Matching object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSMatching --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatching</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-DSMatching -Identity matching -MatchAcrossAddressTypes $true -MatchOnAgent $false</maml:para> <maml:para>Add Matching.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSMatching --> <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-DSMatching</command:name> <command:verb>Set</command:verb> <command:noun>DSMatching</command:noun> <maml:description> <maml:para>Set CDS Matching's parameter values in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSMatching -Identity matching -MatchAcrossAddressTypes $true -MatchOnAgent $false</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSMatching</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Matching, specified by Matching object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSMatching</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatching</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchAcrossObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchAcrossObjectTypes</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchOnAgent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchOnAgent</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchRules</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Matching, specified by Matching object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSMatching</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatching</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchAcrossObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchAcrossObjectTypes</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchOnAgent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchOnAgent</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchRules --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchRules</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatching</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Matching, specified by Matching object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSMatching --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatching</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-DSMatching -Identity matching -MatchAcrossAddressTypes $true -MatchOnAgent $false</maml:para> <maml:para>Changed Matching.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSMatchRule --> <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-DSMatchRule</command:name> <command:verb>New</command:verb> <command:noun>DSMatchRule</command:noun> <maml:description> <maml:para>Create a CDS MatchRule object in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSMatchRule -Identity MatchRule (by object or id) cmdlet adds the specified MatchRule.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Add-DSMatchRule cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSMatchRule</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Add a new MatchRule object.</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> <!-- Parameter: Matching --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Matching</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <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: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Add a new MatchRule object.</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> <!-- Parameter: Matching --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Matching</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <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: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Add a new MatchRule object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSMatchRule --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatchRule</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-DSMatchRule -Identity matchRule -Matching matching -SourceAttribute source -TargetAttribute target -Priority priority</maml:para> <maml:para>Add MatchRule.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSMatchRule --> <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-DSMatchRule</command:name> <command:verb>Set</command:verb> <command:noun>DSMatchRule</command:noun> <maml:description> <maml:para>Set CDS MatchRule's parameter values in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSMatchRule -Identity matchRule -Matching matching -SourceAttribute source -TargetAttribute target -Priority priority</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSMatchRule</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this MatchRule, specified by MatchRule object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSMatchRule</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatchRule</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Matching --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Matching</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchPriority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchPriority</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttribute</maml:name> <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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this MatchRule, specified by MatchRule object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSMatchRule</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatchRule</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Matching --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Matching</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetAttribute</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchPriority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchPriority</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatchRule</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this MatchRule, specified by MatchRule object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSMatchRule --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSMatchRule</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-DSMatchRule -Identity matchRule -Parent parent -Profile profile -ActionType actionType -Test test -ClauseType clauseType</maml:para> <maml:para>Changed MatchRule.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DSOrganizationalUnit --> <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-DSOrganizationalUnit</command:name> <command:verb>Get</command:verb> <command:noun>DSOrganizationalUnit</command:noun> <maml:description> <maml:para>Returns CDS OrganizationalUnits.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-DSOrganizationalUnit -Identity returns a OrganizationalUnit by OrganizationalUnitId, identity, or a OrganizationalUnit object.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-DSOrganizationalUnit cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-DSOrganizationalUnit</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-DSOrganizationalUnit</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSOrganizationalUnit --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSOrganizationalUnit</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-DSOrganizationalUnit -Identity 107</maml:para> <maml:para>Get-DSOrganizationalUnit -Identity 'My OrganizationalUnit'</maml:para> <maml:para>Get-DSOrganizationalUnit -Identity $organizationalUnit</maml:para> <maml:para>Returns a OrganizationalUnit by OrganizationalUnitId, identity, or a OrganizationalUnit object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-DSOrganizationalUnit</maml:para> <maml:para>Returns all OrganizationalUnits.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSOrganizationalUnit --> <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-DSOrganizationalUnit</command:name> <command:verb>Set</command:verb> <command:noun>DSOrganizationalUnit</command:noun> <maml:description> <maml:para>Set CDS OrganizationalUnit's parameter values.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSOrganizationalUnit -Identity OrganizationalUnit (by object or id) cmdlet set the specified OrganizationalUnit's parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSOrganizationalUnit</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">DSOrganizationalUnit</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSOrganizationalUnit</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangeStamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChangeStamp</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FullDiscoveryRequired --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FullDiscoveryRequired</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeSubOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubOUs</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InScope</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsRemoved --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsRemoved</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">DSOrganizationalUnit</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSOrganizationalUnit</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InScope</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeSubOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubOUs</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsRemoved --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsRemoved</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FullDiscoveryRequired --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FullDiscoveryRequired</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangeStamp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChangeStamp</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSOrganizationalUnit</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSOrganizationalUnit --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSOrganizationalUnit</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-DSOrganizationalUnit -Identity organizationalUnit -OrganizationalUnitType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Changed OrganizationalUnit.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DSProfile --> <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-DSProfile</command:name> <command:verb>Get</command:verb> <command:noun>DSProfile</command:noun> <maml:description> <maml:para>Returns CDS Profiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-DSProfile -Identity returns a Profile by ProfileId, identity, or a Profile object.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-DSProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-DSProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Profile identity: ProfileId, Name, or a Profile object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-DSProfile</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Profile identity: ProfileId, Name, or a Profile object.</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> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Profile identity: ProfileId, Name, or a Profile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSProfile</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-DSProfile -Identity 107</maml:para> <maml:para>Get-DSProfile -Identity 'My Profile'</maml:para> <maml:para>Get-DSProfile -Identity $profile</maml:para> <maml:para>Returns a Profile by ProfileId, identity, or a Profile object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-DSProfile</maml:para> <maml:para>Returns all Profiles.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSProfile --> <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-DSProfile</command:name> <command:verb>New</command:verb> <command:noun>DSProfile</command:noun> <maml:description> <maml:para>Create a CDS Profile object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSProfile -Identity Profile (by object or id) cmdlet creates the specified Profile.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-DSProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Profile, specified by Profile object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectFilters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectFilters</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProtectCreatedOUsFromDeletion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtectCreatedOUsFromDeletion</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceOUs</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetDomain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDomain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetOUs</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TenantMigration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantMigration</maml:name> <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: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Profile, specified by Profile object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProtectCreatedOUsFromDeletion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtectCreatedOUsFromDeletion</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TenantMigration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantMigration</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetDomain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDomain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceOUs</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetOUs</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectFilters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectFilters</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Profile, specified by Profile object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSProfile</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSProfile -Identity profile -ProfileType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>New Profile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSProfile --> <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-DSProfile</command:name> <command:verb>Set</command:verb> <command:noun>DSProfile</command:noun> <maml:description> <maml:para>Set CDS Profile's parameter values.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSProfile -Identity Profile (by object or id) cmdlet set the specified Profile's parameters.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-DSProfile cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSProfile</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Profile, specified by Profile object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectFilters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectFilters</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProtectCreatedOUsFromDeletion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtectCreatedOUsFromDeletion</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceOUs</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetDomain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDomain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetOUs</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TenantMigrationId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantMigrationId</maml:name> <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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Profile, specified by Profile object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProtectCreatedOUsFromDeletion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtectCreatedOUsFromDeletion</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TenantMigrationId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantMigrationId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetDomain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetDomain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceOUs</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetOUs</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectFilters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectFilters</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Profile, specified by Profile object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSProfile --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSProfile</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-DSProfile -Identity profile -ProfileType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Changed Profile.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSSchedule --> <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-DSSchedule</command:name> <command:verb>New</command:verb> <command:noun>DSSchedule</command:noun> <maml:description> <maml:para>Create a new CDS Schedule in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSSchedule -Identity Schedule (by object or id) cmdlet creates the specified Schedule.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSSchedule</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Schedule, specified by Schedule object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Frequency --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Frequency</maml:name> <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: ScheduleType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleType</maml:name> <maml:description> <maml:para>Possible values: Manual, ByFrequency, AtSpecificTime</maml:para> </maml:description> <command:parameterValue required="true">ScheduleType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ScheduleType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Manual</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Manual</command:parameterValue> <command:parameterValue required="false" variableLength="false">ByFrequency</command:parameterValue> <command:parameterValue required="false" variableLength="false">AtSpecificTime</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SpecificTimes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SpecificTimes</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Units --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Units</maml:name> <maml:description> <maml:para>Possible values: Seconds, Minutes, Hours, Days, Weeks</maml:para> </maml:description> <command:parameterValue required="true">FrequencyUnits</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.FrequencyUnits</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Seconds</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Seconds</command:parameterValue> <command:parameterValue required="false" variableLength="false">Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hours</command:parameterValue> <command:parameterValue required="false" variableLength="false">Days</command:parameterValue> <command:parameterValue required="false" variableLength="false">Weeks</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Schedule, specified by Schedule object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: ScheduleType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleType</maml:name> <maml:description> <maml:para>Possible values: Manual, ByFrequency, AtSpecificTime</maml:para> </maml:description> <command:parameterValue required="true">ScheduleType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ScheduleType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Manual</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Manual</command:parameterValue> <command:parameterValue required="false" variableLength="false">ByFrequency</command:parameterValue> <command:parameterValue required="false" variableLength="false">AtSpecificTime</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Frequency --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Frequency</maml:name> <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: Units --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Units</maml:name> <maml:description> <maml:para>Possible values: Seconds, Minutes, Hours, Days, Weeks</maml:para> </maml:description> <command:parameterValue required="true">FrequencyUnits</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.FrequencyUnits</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Seconds</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Seconds</command:parameterValue> <command:parameterValue required="false" variableLength="false">Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hours</command:parameterValue> <command:parameterValue required="false" variableLength="false">Days</command:parameterValue> <command:parameterValue required="false" variableLength="false">Weeks</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SpecificTimes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SpecificTimes</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Schedule, specified by Schedule object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSSchedule --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSchedule</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSSchedule -Identity schedule -ScheduleType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Create a new Schedule.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSSchedule --> <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-DSSchedule</command:name> <command:verb>Set</command:verb> <command:noun>DSSchedule</command:noun> <maml:description> <maml:para>Set CDS Schedule's parameter values in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSSchedule -Identity Schedule (by object or id) cmdlet set the specified Schedule's parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSSchedule</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Schedule, specified by Schedule object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSSchedule</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSchedule</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Frequency --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Frequency</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScheduleType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleType</maml:name> <maml:description> <maml:para>Possible values: Manual, ByFrequency, AtSpecificTime</maml:para> </maml:description> <command:parameterValue required="true">ScheduleType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ScheduleType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Manual</command:parameterValue> <command:parameterValue required="false" variableLength="false">ByFrequency</command:parameterValue> <command:parameterValue required="false" variableLength="false">AtSpecificTime</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SpecificTimes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SpecificTimes</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Units --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Units</maml:name> <maml:description> <maml:para>Possible values: Seconds, Minutes, Hours, Days, Weeks</maml:para> </maml:description> <command:parameterValue required="true">FrequencyUnits</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.FrequencyUnits</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Seconds</command:parameterValue> <command:parameterValue required="false" variableLength="false">Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hours</command:parameterValue> <command:parameterValue required="false" variableLength="false">Days</command:parameterValue> <command:parameterValue required="false" variableLength="false">Weeks</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Schedule, specified by Schedule object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSSchedule</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSchedule</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScheduleType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleType</maml:name> <maml:description> <maml:para>Possible values: Manual, ByFrequency, AtSpecificTime</maml:para> </maml:description> <command:parameterValue required="true">ScheduleType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ScheduleType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Manual</command:parameterValue> <command:parameterValue required="false" variableLength="false">ByFrequency</command:parameterValue> <command:parameterValue required="false" variableLength="false">AtSpecificTime</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Frequency --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Frequency</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Units --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Units</maml:name> <maml:description> <maml:para>Possible values: Seconds, Minutes, Hours, Days, Weeks</maml:para> </maml:description> <command:parameterValue required="true">FrequencyUnits</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.FrequencyUnits</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Seconds</command:parameterValue> <command:parameterValue required="false" variableLength="false">Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hours</command:parameterValue> <command:parameterValue required="false" variableLength="false">Days</command:parameterValue> <command:parameterValue required="false" variableLength="false">Weeks</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SpecificTimes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SpecificTimes</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSchedule</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Schedule, specified by Schedule object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSSchedule --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSchedule</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-DSSchedule -Identity schedule -ScheduleType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Changed Schedule.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSScheduleTime --> <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-DSScheduleTime</command:name> <command:verb>New</command:verb> <command:noun>DSScheduleTime</command:noun> <maml:description> <maml:para>Create a new CDS ScheduleTime in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSScheduleTime -Identity ScheduleTime (by object or id) cmdlet creates the specified ScheduleTime.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSScheduleTime</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this ScheduleTime id, specified by ScheduleTime object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Schedule --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DayOfWeek --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DayOfWeek</maml:name> <maml:description> <maml:para>Possible values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday</maml:para> </maml:description> <command:parameterValue required="true">DayOfWeek</command:parameterValue> <dev:type> <maml:name>System.DayOfWeek</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Time --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Time</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this ScheduleTime id, specified by ScheduleTime object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Schedule --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DayOfWeek --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DayOfWeek</maml:name> <maml:description> <maml:para>Possible values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday</maml:para> </maml:description> <command:parameterValue required="true">DayOfWeek</command:parameterValue> <dev:type> <maml:name>System.DayOfWeek</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Time --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Time</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this ScheduleTime id, specified by ScheduleTime object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSScheduleTime --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScheduleTime</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSScheduleTime -Identity scheduleTime -ScheduleId scheduleId -DayOfWeek dayOfWeek -Time time</maml:para> <maml:para>Create a new ScheduleTime.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSScheduleTime --> <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-DSScheduleTime</command:name> <command:verb>Set</command:verb> <command:noun>DSScheduleTime</command:noun> <maml:description> <maml:para>Set CDS ScheduleTime's parameter values in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSScheduleTime -Identity ScheduleTime (by object or id) cmdlet set the specified ScheduleTime's parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSScheduleTime</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this ScheduleTime, specified by ScheduleTime object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSScheduleTime</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScheduleTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DayOfWeek --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DayOfWeek</maml:name> <maml:description> <maml:para>Possible values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday</maml:para> </maml:description> <command:parameterValue required="true">DayOfWeek</command:parameterValue> <dev:type> <maml:name>System.DayOfWeek</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Time --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Time</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this ScheduleTime, specified by ScheduleTime object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSScheduleTime</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScheduleTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DayOfWeek --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DayOfWeek</maml:name> <maml:description> <maml:para>Possible values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday</maml:para> </maml:description> <command:parameterValue required="true">DayOfWeek</command:parameterValue> <dev:type> <maml:name>System.DayOfWeek</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Time --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Time</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScheduleTime</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this ScheduleTime, specified by ScheduleTime object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSScheduleTime --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScheduleTime</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-DSScheduleTime -Identity scheduleTime -DayOfWeek day -Time time</maml:para> <maml:para>Changed ScheduleTime.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSScript --> <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-DSScript</command:name> <command:verb>New</command:verb> <command:noun>DSScript</command:noun> <maml:description> <maml:para>Create a new CDS Script in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSScript -Identity Script (by object or id) cmdlet creates the specified Script.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSScript</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Script, specified by Script object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Environment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScriptText --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptText</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Script, specified by Script object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Environment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScriptText --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptText</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Script, specified by Script object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSScript --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScript</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSScript -Identity script -ScriptType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Create a new Script.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSScript --> <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-DSScript</command:name> <command:verb>Set</command:verb> <command:noun>DSScript</command:noun> <maml:description> <maml:para>Set CDS Script's parameter values in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSScript -Identity Script (by object or id) cmdlet set the specified Script's parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSScript</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Script, specified by Script object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSScript</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScript</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScriptText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptText</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Script, specified by Script object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSScript</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScript</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScriptText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptText</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScript</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Script, specified by Script object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSScript --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSScript</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-DSScript -Identity script -ScriptType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Changed Script.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DSServiceAccount --> <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-DSServiceAccount</command:name> <command:verb>Get</command:verb> <command:noun>DSServiceAccount</command:noun> <maml:description> <maml:para>Returns DirSync ServiceAccounts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-DSServiceAccount -Identity returns the DirSync ServiceAccount identified by its Id, PrincipalName, or a ServiceAccount object.</maml:para> <maml:para>Get-DSServiceAccount [-Type] [-Filter] [-Limit] returns DirSync ServiceAccounts matching selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-DSServiceAccount cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-DSServiceAccount</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-DSServiceAccount</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PrincipalName -like '*123*'". The supported properties are Id, PrincipalName, and EnvironmentName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "PrincipalName -like '*123*'". The supported properties are Id, PrincipalName, and EnvironmentName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServiceAccount --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ServiceAccount</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-DSServiceAccount -Identity 153</maml:para> <maml:para>Get-DSServiceAccount -Identity BTPowerShellUser.123@contoso.com</maml:para> <maml:para>Get-DSServiceAccount -Identity $serviceAccount</maml:para> <maml:para>Returns a DirSync ServiceAccount by id, identity, or a ServiceAccount object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-DSServiceAccount</maml:para> <maml:para>Returns all DirSync ServiceAccounts.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-DSServiceAccount -Filter "PrincipalName -like '*123*'" -Limit 10</maml:para> <maml:para>Returns the first 10 DirSync ServiceAccounts whose PrincipalName matches the pattern.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSServiceAccount --> <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-DSServiceAccount</command:name> <command:verb>Set</command:verb> <command:noun>DSServiceAccount</command:noun> <maml:description> <maml:para>Updates a DirSync ServiceAccount.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-DSServiceAccount -Password sets a DirSync ServiceAccount's password.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Set-DSServiceAccount cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-DSServiceAccount</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</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> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>New password.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</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> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>New password.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DirSync ServiceAccount identity: Id, PrincipalName, or a ServiceAccount object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServiceAccount --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ServiceAccount</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-DSServiceAccount -Identity BTPowerShellUser.123@contoso.com -Password $secureString</maml:para> <maml:para>Set-DSServiceAccount -Identity 153 -Password $secureString</maml:para> <maml:para>Sets the specified DirSync ServiceAccount's password.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSSourceOU --> <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-DSSourceOU</command:name> <command:verb>New</command:verb> <command:noun>DSSourceOU</command:noun> <maml:description> <maml:para>Create a new CDS SourceOU in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSSourceOU -Identity SourceOU (by object or id) cmdlet creates the specified SourceOU.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSSourceOU</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OrganizationalUnit --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationalUnit</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeWellKnownObjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeWellKnownObjects</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeSubOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubOUs</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OrganizationalUnit --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationalUnit</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeSubOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubOUs</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeWellKnownObjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeWellKnownObjects</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSSourceOU --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSourceOU</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSSourceOU -Identity sourceOU -SourceOUType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Create a new SourceOU.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSSourceOU --> <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-DSSourceOU</command:name> <command:verb>Set</command:verb> <command:noun>DSSourceOU</command:noun> <maml:description> <maml:para>Set CDS SourceOU's parameter values in-memory.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSSourceOU</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">DSSourceOU</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSourceOU</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeSubOUs --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubOUs</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeWellKnownObjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeWellKnownObjects</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">DSSourceOU</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSourceOU</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeSubOUs --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubOUs</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeWellKnownObjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeWellKnownObjects</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSourceOU</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSSourceOU --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSSourceOU</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-DSSourceOU -Identity sourceOU -SourceOUType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Changed SourceOU.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSTargetOU --> <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-DSTargetOU</command:name> <command:verb>New</command:verb> <command:noun>DSTargetOU</command:noun> <maml:description> <maml:para>Create a new CDS TargetOU in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSTargetOU -Identity TargetOU (by object or id) cmdlet creates the specified TargetOU.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSTargetOU</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OrganizationalUnit --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationalUnit</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeWellKnownObjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeWellKnownObjects</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeSubOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubOUs</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: ObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OrganizationalUnit --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationalUnit</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectTypes</maml:name> <maml:description> <maml:para>Possible values: None, User, Contact, SecurityGroup, DistributionGroup, UnifiedGroup, Computer, ResourceMailbox, OrganizationalUnit, Team, All, NonMailEnabledUser, MailEnabledUser, MailboxEnabledUser, GuestUser, DeviceEntraIDJoined, NonMailEnabledSecurityGroup, MailEnabledSecurityGroup</maml:para> </maml:description> <command:parameterValue required="true">ObjectTypes</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.ObjectTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">User</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contact</command:parameterValue> <command:parameterValue required="false" variableLength="false">SecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnifiedGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Computer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceMailbox</command:parameterValue> <command:parameterValue required="false" variableLength="false">OrganizationalUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailboxEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">GuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceEntraIDJoined</command:parameterValue> <command:parameterValue required="false" variableLength="false">NonMailEnabledSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">MailEnabledSecurityGroup</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeSubOUs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubOUs</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeWellKnownObjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeWellKnownObjects</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSTargetOU --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSTargetOU</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSTargetOU -Identity targetOU -TargetOUType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Create a new TargetOU.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSTargetOU --> <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-DSTargetOU</command:name> <command:verb>Set</command:verb> <command:noun>DSTargetOU</command:noun> <maml:description> <maml:para>Set CDS TargetOU's parameter values in-memory.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSTargetOU</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">DSTargetOU</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSTargetOU</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateOuOptions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateOuOptions</maml:name> <maml:description> <maml:para>Possible values: None, FromSource, FromObjectType</maml:para> </maml:description> <command:parameterValue required="true">CreateOuOptions</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateOuOptions</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">FromSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">FromObjectType</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <command:parameterValue required="true">DSTargetOU</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSTargetOU</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateOuOptions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateOuOptions</maml:name> <maml:description> <maml:para>Possible values: None, FromSource, FromObjectType</maml:para> </maml:description> <command:parameterValue required="true">CreateOuOptions</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateOuOptions</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">FromSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">FromObjectType</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSTargetOU</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSTargetOU --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSTargetOU</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-DSTargetOU -Identity targetOU -TargetOUType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Changed TargetOU.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DSTemplate --> <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-DSTemplate</command:name> <command:verb>Get</command:verb> <command:noun>DSTemplate</command:noun> <maml:description> <maml:para>Returns CDS Templates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-DSTemplate -Identity returns a Template by TemplateId, identity, or a Template object.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-DSTemplate cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-DSTemplate</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Template identity: TemplateId, Name, or a Template object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-DSTemplate</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Template identity: TemplateId, Name, or a Template object.</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> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Template identity: TemplateId, Name, or a Template object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSTemplate --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSTemplate</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-DSTemplate -Identity 107</maml:para> <maml:para>Get-DSTemplate -Identity 'My Template'</maml:para> <maml:para>Get-DSTemplate -Identity $template</maml:para> <maml:para>Returns a Template by TemplateId, identity, or a Template object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-DSTemplate</maml:para> <maml:para>Returns all Templates.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSTemplate --> <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-DSTemplate</command:name> <command:verb>New</command:verb> <command:noun>DSTemplate</command:noun> <maml:description> <maml:para>Create a CDS Template object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSTemplate -Identity Template (by object or id) cmdlet creates the specified Template.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-DSTemplate cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>New-DSTemplate</maml:name> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Template, specified by Template object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: DefaultPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironmentType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironmentType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ActiveDirectory</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: TargetEnvironmentType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironmentType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ActiveDirectory</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ComputerAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContactAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContactAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsEnabled, AsDisabled</maml:para> </maml:description> <command:parameterValue required="true">CreateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateComputer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDisabled</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateContact</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs</maml:para> </maml:description> <command:parameterValue required="true">CreateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateContact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateDomainLocalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateDomainLocalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateGlobalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateGlobalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsDistributionGroup, AsSecurityGroup, AsOffice365Group, AsContact</maml:para> </maml:description> <command:parameterValue required="true">CreateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsOffice365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsDistributionGroup, AsSecurityGroup, AsOffice365Group, AsContact, AsTeam</maml:para> </maml:description> <command:parameterValue required="true">CreateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateTeam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsOffice365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsTeam</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateUniversalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateUniversalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateUser</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsEnabledUser, AsDisabledUser, AsContact, AsDomain, AsGuestUser, AsGuestInvite</maml:para> </maml:description> <command:parameterValue required="true">CreateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDisabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGuestInvite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <command:parameterValue required="true">ICollection`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.ICollection`1[[BinaryTree.Power365.SDK.DSMapping, BinaryTree.Power365.SDK, Version=20.12.15.6019, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreserveTargetAttributeChanges --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveTargetAttributeChanges</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProtectCreatedOUsFromDeletion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtectCreatedOUsFromDeletion</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ResetPasswordOnFirstLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResetPasswordOnFirstLogin</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncScope</maml:name> <maml:description> <maml:para>Possible values: SyncEverything, SyncDeltasOnly, SyncT2TPrepare, SyncT2TProvision, SyncT2TCutoverTarget, SyncT2TCutoverSource, SyncT2TRemoveDomain, SyncT2TAddDomain</maml:para> </maml:description> <command:parameterValue required="true">SyncScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SyncEverything</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncDeltasOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TPrepare</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TProvision</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverTarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TRemoveDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TAddDomain</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SyncSidHistory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncSidHistory</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TenantMigrationId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantMigrationId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateCreatedComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateComputer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedContact</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateContact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge</maml:para> </maml:description> <command:parameterValue required="true">UpdateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateTeam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedUser</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, MergeAndKeepType, MergeAndConvertToUser, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndKeepType</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndConvertToUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMailboxes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMailboxes</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateMatchedComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateComputer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedContact</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateContact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge</maml:para> </maml:description> <command:parameterValue required="true">UpdateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateTeam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedUser</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, MergeAndKeepType, MergeAndConvertToUser, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndKeepType</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndConvertToUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UPNSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UPNSuffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserLicensing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserLicensing</maml:name> <maml:description> <maml:para>Possible values: Unlicensed, Licensed</maml:para> </maml:description> <command:parameterValue required="true">UserLicensing</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UserLicensing</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unlicensed</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unlicensed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Licensed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserTargetAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserTargetAddress</maml:name> <maml:description> <maml:para>Possible values: DoNotOverwrite, OverwriteFirstSync, OverwriteAlways</maml:para> </maml:description> <command:parameterValue required="true">UserTargetAddress</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UserTargetAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotOverwrite</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotOverwrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">OverwriteFirstSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">OverwriteAlways</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Template, specified by Template object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironmentType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironmentType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ActiveDirectory</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: TargetEnvironmentType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironmentType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ActiveDirectory</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateUser</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsEnabledUser, AsDisabledUser, AsContact, AsDomain, AsGuestUser, AsGuestInvite</maml:para> </maml:description> <command:parameterValue required="true">CreateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDisabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGuestInvite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedUser</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, MergeAndKeepType, MergeAndConvertToUser, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndKeepType</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndConvertToUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedUser</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, MergeAndKeepType, MergeAndConvertToUser, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndKeepType</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndConvertToUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UPNSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UPNSuffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserTargetAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserTargetAddress</maml:name> <maml:description> <maml:para>Possible values: DoNotOverwrite, OverwriteFirstSync, OverwriteAlways</maml:para> </maml:description> <command:parameterValue required="true">UserTargetAddress</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UserTargetAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotOverwrite</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotOverwrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">OverwriteFirstSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">OverwriteAlways</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserLicensing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserLicensing</maml:name> <maml:description> <maml:para>Possible values: Unlicensed, Licensed</maml:para> </maml:description> <command:parameterValue required="true">UserLicensing</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UserLicensing</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Unlicensed</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unlicensed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Licensed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsDistributionGroup, AsSecurityGroup, AsOffice365Group, AsContact</maml:para> </maml:description> <command:parameterValue required="true">CreateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsOffice365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: GroupAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateDomainLocalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateDomainLocalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateGlobalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateGlobalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateUniversalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateUniversalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateContact</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs</maml:para> </maml:description> <command:parameterValue required="true">CreateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateContact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedContact</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateContact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedContact</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateContact</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ContactAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContactAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsDistributionGroup, AsSecurityGroup, AsOffice365Group, AsContact, AsTeam</maml:para> </maml:description> <command:parameterValue required="true">CreateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateTeam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsOffice365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsTeam</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge</maml:para> </maml:description> <command:parameterValue required="true">UpdateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateTeam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge</maml:para> </maml:description> <command:parameterValue required="true">UpdateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateTeam</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsEnabled, AsDisabled</maml:para> </maml:description> <command:parameterValue required="true">CreateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateComputer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotCreate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDisabled</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateComputer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateComputer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DoNotSync</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ComputerAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResetPasswordOnFirstLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResetPasswordOnFirstLogin</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SyncSidHistory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncSidHistory</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveTargetAttributeChanges --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveTargetAttributeChanges</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UpdateMailboxes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMailboxes</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SyncScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncScope</maml:name> <maml:description> <maml:para>Possible values: SyncEverything, SyncDeltasOnly, SyncT2TPrepare, SyncT2TProvision, SyncT2TCutoverTarget, SyncT2TCutoverSource, SyncT2TRemoveDomain, SyncT2TAddDomain</maml:para> </maml:description> <command:parameterValue required="true">SyncScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SyncEverything</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncDeltasOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TPrepare</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TProvision</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverTarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TRemoveDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TAddDomain</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <command:parameterValue required="true">ICollection`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.ICollection`1[[BinaryTree.Power365.SDK.DSMapping, BinaryTree.Power365.SDK, Version=20.12.15.6019, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceFilter</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProtectCreatedOUsFromDeletion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtectCreatedOUsFromDeletion</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TenantMigrationId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantMigrationId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Template, specified by Template object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSTemplate --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSTemplate</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSTemplate -Identity template -TemplateType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>New Template.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSTemplate --> <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-DSTemplate</command:name> <command:verb>Set</command:verb> <command:noun>DSTemplate</command:noun> <maml:description> <maml:para>Set CDS Template's parameter values.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSTemplate -Identity Template (by object or id) cmdlet set the specified Template's parameters.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-DSTemplate cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSTemplate</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Template, specified by Template object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: ComputerAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContactAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContactAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsEnabled, AsDisabled</maml:para> </maml:description> <command:parameterValue required="true">CreateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateComputer</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDisabled</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateContact</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs</maml:para> </maml:description> <command:parameterValue required="true">CreateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateContact</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateDomainLocalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateDomainLocalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateGlobalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateGlobalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsDistributionGroup, AsSecurityGroup, AsOffice365Group, AsContact</maml:para> </maml:description> <command:parameterValue required="true">CreateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateGroup</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsOffice365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsDistributionGroup, AsSecurityGroup, AsOffice365Group, AsContact, AsTeam</maml:para> </maml:description> <command:parameterValue required="true">CreateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateTeam</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsOffice365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsTeam</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateUniversalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateUniversalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateUser</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsEnabledUser, AsDisabledUser, AsContact, AsDomain, AsGuestUser, AsGuestInvite</maml:para> </maml:description> <command:parameterValue required="true">CreateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateUser</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDisabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGuestInvite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DefaultPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreserveTargetAttributeChanges --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveTargetAttributeChanges</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResetPasswordOnFirstLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResetPasswordOnFirstLogin</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironmentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironmentType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SyncScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncScope</maml:name> <maml:description> <maml:para>Possible values: SyncEverything, SyncDeltasOnly, SyncT2TPrepare, SyncT2TProvision, SyncT2TCutoverTarget, SyncT2TCutoverSource, SyncT2TRemoveDomain, SyncT2TAddDomain</maml:para> </maml:description> <command:parameterValue required="true">SyncScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SyncEverything</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncDeltasOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TPrepare</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TProvision</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverTarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TRemoveDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TAddDomain</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SyncSidHistory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncSidHistory</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironmentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironmentType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateComputer</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedContact</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateContact</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateGroup</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge</maml:para> </maml:description> <command:parameterValue required="true">UpdateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateTeam</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedUser</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, MergeAndKeepType, MergeAndConvertToUser, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateUser</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndKeepType</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndConvertToUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMailboxes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMailboxes</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateMatchedComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateComputer</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedContact</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateContact</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateGroup</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge</maml:para> </maml:description> <command:parameterValue required="true">UpdateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateTeam</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedUser</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, MergeAndKeepType, MergeAndConvertToUser, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateUser</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndKeepType</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndConvertToUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UPNSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UPNSuffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserLicensing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserLicensing</maml:name> <maml:description> <maml:para>Possible values: Unlicensed, Licensed</maml:para> </maml:description> <command:parameterValue required="true">UserLicensing</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UserLicensing</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unlicensed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Licensed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserTargetAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserTargetAddress</maml:name> <maml:description> <maml:para>Possible values: DoNotOverwrite, OverwriteFirstSync, OverwriteAlways</maml:para> </maml:description> <command:parameterValue required="true">UserTargetAddress</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UserTargetAddress</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotOverwrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">OverwriteFirstSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">OverwriteAlways</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Template, specified by Template object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironmentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironmentType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: TargetEnvironmentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironmentType</maml:name> <maml:description> <maml:para>Possible values: ActiveDirectory, Office365, All</maml:para> </maml:description> <command:parameterValue required="true">EndpointType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.EndpointType</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Office365</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateUser</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsEnabledUser, AsDisabledUser, AsContact, AsDomain, AsGuestUser, AsGuestInvite</maml:para> </maml:description> <command:parameterValue required="true">CreateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateUser</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsEnabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDisabledUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGuestUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGuestInvite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedUser</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, MergeAndKeepType, MergeAndConvertToUser, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateUser</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndKeepType</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndConvertToUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedUser</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, MergeAndKeepType, MergeAndConvertToUser, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateUser</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateUser</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndKeepType</command:parameterValue> <command:parameterValue required="false" variableLength="false">MergeAndConvertToUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UPNSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UPNSuffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserTargetAddress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserTargetAddress</maml:name> <maml:description> <maml:para>Possible values: DoNotOverwrite, OverwriteFirstSync, OverwriteAlways</maml:para> </maml:description> <command:parameterValue required="true">UserTargetAddress</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UserTargetAddress</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotOverwrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">OverwriteFirstSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">OverwriteAlways</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserLicensing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserLicensing</maml:name> <maml:description> <maml:para>Possible values: Unlicensed, Licensed</maml:para> </maml:description> <command:parameterValue required="true">UserLicensing</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UserLicensing</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unlicensed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Licensed</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsDistributionGroup, AsSecurityGroup, AsOffice365Group, AsContact</maml:para> </maml:description> <command:parameterValue required="true">CreateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateGroup</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsOffice365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateGroup</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateGroup</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateGroup</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: GroupAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateDomainLocalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateDomainLocalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateGlobalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateGlobalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateUniversalGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateUniversalGroup</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsUniversal, AsGlobal, AsDomainLocal</maml:para> </maml:description> <command:parameterValue required="true">SyncGroupScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncGroupScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsUniversal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsGlobal</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDomainLocal</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateContact</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs</maml:para> </maml:description> <command:parameterValue required="true">CreateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateContact</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedContact</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateContact</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedContact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedContact</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateContact</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateContact</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ContactAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContactAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsDistributionGroup, AsSecurityGroup, AsOffice365Group, AsContact, AsTeam</maml:para> </maml:description> <command:parameterValue required="true">CreateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateTeam</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDistributionGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsSecurityGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsOffice365Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsContact</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsTeam</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge</maml:para> </maml:description> <command:parameterValue required="true">UpdateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateTeam</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedTeam --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedTeam</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge</maml:para> </maml:description> <command:parameterValue required="true">UpdateTeam</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateTeam</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CreateComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotCreate, AsIs, AsEnabled, AsDisabled</maml:para> </maml:description> <command:parameterValue required="true">CreateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.CreateComputer</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsIs</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">AsDisabled</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateCreatedComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateCreatedComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateComputer</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UpdateMatchedComputer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMatchedComputer</maml:name> <maml:description> <maml:para>Possible values: DoNotSync, Merge, CreateWithPrefix, CreateWithSuffix, MoveObject</maml:para> </maml:description> <command:parameterValue required="true">UpdateComputer</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.UpdateComputer</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNotSync</command:parameterValue> <command:parameterValue required="false" variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithPrefix</command:parameterValue> <command:parameterValue required="false" variableLength="false">CreateWithSuffix</command:parameterValue> <command:parameterValue required="false" variableLength="false">MoveObject</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ComputerAffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerAffix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResetPasswordOnFirstLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResetPasswordOnFirstLogin</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncSidHistory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncSidHistory</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreserveTargetAttributeChanges --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreserveTargetAttributeChanges</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsArchived --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsArchived</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateMailboxes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMailboxes</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncScope</maml:name> <maml:description> <maml:para>Possible values: SyncEverything, SyncDeltasOnly, SyncT2TPrepare, SyncT2TProvision, SyncT2TCutoverTarget, SyncT2TCutoverSource, SyncT2TRemoveDomain, SyncT2TAddDomain</maml:para> </maml:description> <command:parameterValue required="true">SyncScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SyncEverything</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncDeltasOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TPrepare</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TProvision</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverTarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TRemoveDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TAddDomain</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Mappings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mappings</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Template, specified by Template object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSTemplate --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSTemplate</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-DSTemplate -Identity template -TemplateType type -Frequency frequency -Units frequencyUnits</maml:para> <maml:para>Changed Template.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DSWorkflow --> <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-DSWorkflow</command:name> <command:verb>Get</command:verb> <command:noun>DSWorkflow</command:noun> <maml:description> <maml:para>Returns CDS Workflows.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-DSWorkflow -Identity returns a Workflow by WorkflowId, identity, or a Workflow object.</maml:para> <maml:para>Get-DSWorkflow [-Filter] [-Limit] returns Workflows that match selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-DSWorkflow cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-DSWorkflow</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Workflow identity: WorkflowId, Name, or a Workflow object.</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> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-DSWorkflow</maml:name> <!-- Parameter: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are WorkflowId and 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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Schedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Workflow identity: WorkflowId, Name, or a Workflow object.</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> <!-- Parameter: Schedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are WorkflowId and 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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Detailed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Detailed</maml:name> <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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Workflow identity: WorkflowId, Name, or a Workflow object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSWorkflow --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSWorkflow</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-DSWorkflow -Identity 107</maml:para> <maml:para>Get-DSWorkflow -Identity 'My Workflow'</maml:para> <maml:para>Get-DSWorkflow -Identity $workflow</maml:para> <maml:para>Returns a Workflow by WorkflowId, identity, or a Workflow object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-DSWorkflow</maml:para> <maml:para>Returns all Workflows.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-DSWorkflow -Filter "Name -like 'M*'" -Limit 3</maml:para> <maml:para>Returns the first 3 Workflows whose Name starts with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSWorkflow --> <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-DSWorkflow</command:name> <command:verb>New</command:verb> <command:noun>DSWorkflow</command:noun> <maml:description> <maml:para>Create a new CDS Workflow.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSWorkflow -Identity Workflow (by object or id) cmdlet creates the specified Workflow.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the New-DSWorkflow cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-DSWorkflow</maml:name> <!-- Parameter: Environments --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsSimulation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSimulation</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Schedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipScripts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipScripts</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SyncScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncScope</maml:name> <maml:description> <maml:para>Possible values: SyncEverything, SyncDeltasOnly, SyncT2TPrepare, SyncT2TProvision, SyncT2TCutoverTarget, SyncT2TCutoverSource, SyncT2TRemoveDomain, SyncT2TAddDomain</maml:para> </maml:description> <command:parameterValue required="true">SyncScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SyncEverything</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SyncEverything</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncDeltasOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TPrepare</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TProvision</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverTarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TRemoveDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TAddDomain</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Limit scope to this Workflow, specified by Workflow object. Defaults to the Session's default Project, if any.</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: Identity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Limit scope to this Workflow, specified by Workflow object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Schedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsSimulation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSimulation</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SkipScripts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipScripts</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SyncScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncScope</maml:name> <maml:description> <maml:para>Possible values: SyncEverything, SyncDeltasOnly, SyncT2TPrepare, SyncT2TProvision, SyncT2TCutoverTarget, SyncT2TCutoverSource, SyncT2TRemoveDomain, SyncT2TAddDomain</maml:para> </maml:description> <command:parameterValue required="true">SyncScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SyncEverything</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SyncEverything</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncDeltasOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TPrepare</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TProvision</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverTarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TRemoveDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TAddDomain</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Environments --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DSWorkflow --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSWorkflow</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSWorkflow -Identity 4296</maml:para> <maml:para>Create a new Workflow.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSWorkflow --> <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-DSWorkflow</command:name> <command:verb>Set</command:verb> <command:noun>DSWorkflow</command:noun> <maml:description> <maml:para>Set new property values in a CDS Workflow.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSWorkflow -Identity Workflow (by object or id) cmdlet sets properties in the specified Workflow.</maml:para> <maml:para>The ApiKey role must be 'QAA' to run the Set-DSWorkflow cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSWorkflow</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Workflow, specified by Workflow object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsSimulation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSimulation</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextExecutionDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextExecutionDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">DSProfile</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSProfile</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Schedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipScripts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipScripts</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncScope</maml:name> <maml:description> <maml:para>Possible values: SyncEverything, SyncDeltasOnly, SyncT2TPrepare, SyncT2TProvision, SyncT2TCutoverTarget, SyncT2TCutoverSource, SyncT2TRemoveDomain, SyncT2TAddDomain</maml:para> </maml:description> <command:parameterValue required="true">SyncScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SyncEverything</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncDeltasOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TPrepare</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TProvision</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverTarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TRemoveDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TAddDomain</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: WorkflowSteps --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkflowSteps</maml:name> <command:parameterValue required="true">ICollection`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.ICollection`1[[BinaryTree.Power365.SDK.DSCommand, BinaryTree.Power365.SDK, Version=20.12.15.6019, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Workflow, specified by Workflow object. Defaults to the Session's default Project, if any.</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> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Schedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schedule</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsSimulation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsSimulation</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextExecutionDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextExecutionDate</maml:name> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipScripts --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipScripts</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncScope --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncScope</maml:name> <maml:description> <maml:para>Possible values: SyncEverything, SyncDeltasOnly, SyncT2TPrepare, SyncT2TProvision, SyncT2TCutoverTarget, SyncT2TCutoverSource, SyncT2TRemoveDomain, SyncT2TAddDomain</maml:para> </maml:description> <command:parameterValue required="true">SyncScope</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.SyncScope</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SyncEverything</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncDeltasOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TPrepare</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TProvision</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverTarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TCutoverSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TRemoveDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">SyncT2TAddDomain</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: WorkflowSteps --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkflowSteps</maml:name> <command:parameterValue required="true">ICollection`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.ICollection`1[[BinaryTree.Power365.SDK.DSCommand, BinaryTree.Power365.SDK, Version=20.12.15.6019, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environments</maml:name> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">DSProfile</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSProfile</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Workflow, specified by Workflow object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSWorkflow --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSWorkflow</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-DSWorkflow -Identity 4296 -Description "New description"</maml:para> <maml:para>Set a Workflow description property.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-DSWorkflow --> <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-DSWorkflow</command:name> <command:verb>Start</command:verb> <command:noun>DSWorkflow</command:noun> <maml:description> <maml:para>Start a CDS Workflow.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Start-DSWorkflow -Identity Workflow (by object or id) cmdlet starts the specified Workflow.</maml:para> <maml:para>The ApiKey role must be 'Writer' to run the Start-DSWorkflow cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-DSWorkflow</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the identity (as a Workflow object or id) of a Workflow to start.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the identity (as a Workflow object or id) of a Workflow to start.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the identity (as a Workflow object or id) of a Workflow to start.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSWorkflow --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSWorkflow</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Start-DSWorkflow -Identity 4296</maml:para> <maml:para>Start a Workflow.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DSWorkflowLog --> <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-DSWorkflowLog</command:name> <command:verb>Get</command:verb> <command:noun>DSWorkflowLog</command:noun> <maml:description> <maml:para>Returns the Logs for a specified CDS WorkflowRun.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-DSWorkflowLog -Identity (WorkflowRun object or id) cmdlet matches only one identity.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-DSWorkflowLog cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-DSWorkflowLog</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: WorkflowRunId or WorkflowRun object.</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Level -eq 'Error'". The supported properties are JobLogId, Level, TimeStamp, Message, and AgentId.</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: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity: WorkflowRunId or WorkflowRun object.</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> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Levels</maml:name> <maml:description> <maml:para>Filter by level(s): Error, Warn, Info, Debug, and/or Trace.</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: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "Level -eq 'Error'". The supported properties are JobLogId, Level, TimeStamp, Message, and AgentId.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</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-DSWorkFlowLog -Identity 4926 -Limit 10</maml:para> <maml:para>Returns the most recent 10 Logs for WorkflowRun 4926.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DSWorkflowRun --> <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-DSWorkflowRun</command:name> <command:verb>Get</command:verb> <command:noun>DSWorkflowRun</command:noun> <maml:description> <maml:para>Returns CDS WorkflowRuns.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-WorkflowRun -Identity returns a WorkflowRun by WorkflowRunId or a WorkflowRun object.</maml:para> <maml:para>Get-WorkflowRun [-Filter] [-Limit] [-Workflow] returns WorkflowRuns that match selection criteria.</maml:para> <maml:para>The ApiKey role must be 'Reader' or 'Writer' to run the Get-WorkflowRun cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Get-DSWorkflowRun</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>WorkflowRun identity: WorkflowRunId or WorkflowRun object.</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> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFilter --> <command:syntaxItem> <maml:name>Get-DSWorkflowRun</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WorkflowName -like 'My*'". The supported properties are WorkflowRunId, WorkflowId, and WorkflowName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Filter by Workflow (WorkflowId, Name, or Workflow object).</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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>WorkflowRun identity: WorkflowRunId or WorkflowRun object.</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> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Filter by Workflow (WorkflowId, Name, or Workflow object).</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> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter expression. The filter is in OPath syntax, such as "WorkflowName -like 'My*'". The supported properties are WorkflowRunId, WorkflowId, and WorkflowName.</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: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limit the number of returned items.</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: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>WorkflowRun identity: WorkflowRunId or WorkflowRun object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSWorkflowRun --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSWorkflowRun</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-WorkflowRun -Identity 766</maml:para> <maml:para>Get-WorkflowRun -Identity $workflowRun</maml:para> <maml:para>Gets a WorkflowRun by WorkflowRunId or WorkflowRun object.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-WorkflowRun</maml:para> <maml:para>Returns all WorkflowRuns.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-WorkflowRun -Filter "WorkflowName -like 'M*'" -Limit 5</maml:para> <maml:para>Returns the 5 most recent WorkflowRuns for Workflows whose names start with 'M'.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-DSWorkflowStep --> <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-DSWorkflowStep</command:name> <command:verb>New</command:verb> <command:noun>DSWorkflowStep</command:noun> <maml:description> <maml:para>Create a new CDS WorkflowStep in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DSWorkflowStep cmdlet creates the specified workflow step.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-DSWorkflowStep</maml:name> <!-- Parameter: StepType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StepType</maml:name> <maml:description> <maml:para>Possible values: Delete, Match, Write, Read, Stage, Script</maml:para> </maml:description> <command:parameterValue required="true">StepType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.StepType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Delete</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Delete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Match</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stage</command:parameterValue> <command:parameterValue required="false" variableLength="false">Script</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ActiveExecutionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveExecutionId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Identity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>Possible values: Low, Medium, High</maml:para> </maml:description> <command:parameterValue required="true">LogLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LogLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Medium</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Low</command:parameterValue> <command:parameterValue required="false" variableLength="false">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">High</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Matching --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Matching</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Script --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StopWorkflowOnFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StopWorkflowOnFailure</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <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: Identity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Identity</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StepType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StepType</maml:name> <maml:description> <maml:para>Possible values: Delete, Match, Write, Read, Stage, Script</maml:para> </maml:description> <command:parameterValue required="true">StepType</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.StepType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Delete</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Delete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Match</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stage</command:parameterValue> <command:parameterValue required="false" variableLength="false">Script</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>Possible values: Low, Medium, High</maml:para> </maml:description> <command:parameterValue required="true">LogLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LogLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Medium</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Low</command:parameterValue> <command:parameterValue required="false" variableLength="false">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">High</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SourceEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEnvironment</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Matching --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Matching</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Script --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StopWorkflowOnFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StopWorkflowOnFailure</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActiveExecutionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveExecutionId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workflow</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DSCommand --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSCommand</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-DSWorkflowStep -Workflow workflowIdentity -StepType type</maml:para> <maml:para>New WorkflowStep.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DSWorkflowStep --> <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-DSWorkflowStep</command:name> <command:verb>Set</command:verb> <command:noun>DSWorkflowStep</command:noun> <maml:description> <maml:para>Set CDS Command's parameter values in-memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-DSWorkflowStep -Identity Command (by object or id) cmdlet set the specified Command's parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByIdentity --> <command:syntaxItem> <maml:name>Set-DSWorkflowStep</maml:name> <!-- Parameter: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Command, specified by Command object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSCommand</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSCommand</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActiveExecutionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveExecutionId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>Possible values: Low, Medium, High</maml:para> </maml:description> <command:parameterValue required="true">LogLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LogLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Medium</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Low</command:parameterValue> <command:parameterValue required="false" variableLength="false">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">High</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Matching --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Matching</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Script --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEndpoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEndpoint</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StopWorkflowOnFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StopWorkflowOnFailure</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEndpoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEndpoint</maml:name> <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: Identity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Limit scope to this Command, specified by Command object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> <command:parameterValue required="true">DSCommand</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSCommand</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceEndpoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceEndpoint</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetEndpoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetEndpoint</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Matching --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Matching</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Script --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StopWorkflowOnFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StopWorkflowOnFailure</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActiveExecutionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveExecutionId</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>Possible values: Low, Medium, High</maml:para> </maml:description> <command:parameterValue required="true">LogLevel</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.LogLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Medium</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Low</command:parameterValue> <command:parameterValue required="false" variableLength="false">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">High</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.</maml:para> </maml:description> <command:parameterValue required="true">Session</command:parameterValue> <dev:type> <maml:name>BinaryTree.Power365.Cmdlet.Session</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSCommand</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Limit scope to this Command, specified by Command object. Defaults to the Session's default Project, if any.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DSCommand --> <command:returnValue> <dev:type> <maml:name>BinaryTree.Power365.SDK.DSCommand</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-DSWorkflowStep -Identity command -Priority 5</maml:para> <maml:para>Changed Command.</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> </helpItems> |