en-US/Jagabata.psm.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Approve-AnsibleWorkflowApprovalRequest</command:name> <command:verb>Approve</command:verb> <command:noun>AnsibleWorkflowApprovalRequest</command:noun> <maml:description> <maml:para>Approve requests for WorkflowApproval.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Approve requests for pending WorkflowApprovals. And output the results for jobs of those.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_approvals/{id}/approve/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Approve-AnsibleWorkflowApprovalRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Database ID for the WorkflowApproval.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Database ID for the WorkflowApproval.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.ResourceType</maml:name> </dev:type> <maml:description> <maml:para>Input by `Type` property in the pipeline object.</maml:para> <maml:para>Acceptable values: `WorkflowApproval` (only)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Input by `Id` property in the pipeline object.</maml:para> <maml:para>Database ID for `WorkflowApproval`</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowApproval</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Approve-AnsibleWorkflowApprovalRequest -Id 1</dev:code> <dev:remarks> <maml:para>Approve the WorkflowApproval of ID 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowApprovalRequest -Status pending | Approve-AnsibleWorkflowApprovalRequest</dev:code> <dev:remarks> <maml:para>Approve all pending WorkflowApprovals.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Deny-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Deny-AnsibleWorkflowApprovalRequest</command:name> <command:verb>Deny</command:verb> <command:noun>AnsibleWorkflowApprovalRequest</command:noun> <maml:description> <maml:para>Deny requests for WorkflowApproval.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deny requests for pending WorkflowApprovals. And output the results for jobs of those.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_approvals/{id}/deny/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Deny-AnsibleWorkflowApprovalRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Database ID for the WorkflowApproval.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Database ID for the WorkflowApproval.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.ResourceType</maml:name> </dev:type> <maml:description> <maml:para>Input by `Type` property in the pipeline object.</maml:para> <maml:para>Acceptable values: `WorkflowApproval` (only)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Input by `Id` property in the pipeline object.</maml:para> <maml:para>Database ID for `WorkflowApproval`</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowApproval</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Deny-AnsibleWorkflowApprovalRequest -Id 1</dev:code> <dev:remarks> <maml:para>Deny the WorkflowApproval of ID 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowApprovalRequest -Status pending | Deny-AnsibleWorkflowApprovalRequest</dev:code> <dev:remarks> <maml:para>Deny all pending WorkflowApprovals.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Approve-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-AnsibleNotificationTemplate</command:name> <command:verb>Disable</command:verb> <command:noun>AnsibleNotificationTemplate</command:noun> <maml:description> <maml:para>Disable a NotificationTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disable notification at the specified timings (`Started`, `Success`, `Error` and `Approval`) for the target resource (`Organization`, `Project`, `InventorySource`, `JobTemplate`, `SystemJobTemplate` and `WorkflowJobTemplate`). The timing `Approval` is only available for `Organization` and `WorkflowJobTemplate`.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/organizations/{id}/notification_templates_approvals/` (POST) - `/api/v2/organizations/{id}/notification_templates_error/` (POST) - `/api/v2/organizations/{id}/notification_templates_started/` (POST) - `/api/v2/organizations/{id}/notification_templates_success/` (POST) - `/api/v2/projects/{id}/notification_templates_error/` (POST) - `/api/v2/projects/{id}/notification_templates_started/` (POST) - `/api/v2/projects/{id}/notification_templates_success/` (POST) - `/api/v2/inventory_sources/{id}/notification_templates_error/` (POST) - `/api/v2/inventory_sources/{id}/notification_templates_started/` (POST) - `/api/v2/inventory_sources/{id}/notification_templates_success/` (POST) - `/api/v2/job_templates/{id}/notification_templates_error/` (POST) - `/api/v2/job_templates/{id}/notification_templates_started/` (POST) - `/api/v2/job_templates/{id}/notification_templates_success/` (POST) - `/api/v2/system_job_templates/{id}/notification_templates_error/` (POST) - `/api/v2/system_job_templates/{id}/notification_templates_started/` (POST) - `/api/v2/system_job_templates/{id}/notification_templates_success/` (POST) - `/api/v2/workflow_job_templates/{id}/notification_templates_approvals/` (POST) - `/api/v2/workflow_job_templates/{id}/notification_templates_error/` (POST) - `/api/v2/workflow_job_templates/{id}/notification_templates_started/` (POST) - `/api/v2/workflow_job_templates/{id}/notification_templates_success/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AnsibleNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>NotificationTemplate ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>For</maml:name> <maml:description> <maml:para>The target resource to be enabled the notification.</maml:para> <maml:para>The available resources: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>On</maml:name> <maml:description> <maml:para>Timing of notifications to be enabled.</maml:para> <maml:para>Available timings: - `Started` - `Success` - `Error` - `Approval` (only for `Organization` and `WorkflowJobTemplate` resource)</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Started</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Success</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Approval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>For</maml:name> <maml:description> <maml:para>The target resource to be enabled the notification.</maml:para> <maml:para>The available resources: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>NotificationTemplate ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>On</maml:name> <maml:description> <maml:para>Timing of notifications to be enabled.</maml:para> <maml:para>Available timings: - `Started` - `Success` - `Error` - `Approval` (only for `Organization` and `WorkflowJobTemplate` resource)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>NotificationTemplate ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Disable-AnsibleNotificationTemplate -Id 5 -For (Get-AnsibleJobTemplate -Id 3) -On Success,Error</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-AnsibleNotificationTemplate</command:name> <command:verb>Enable</command:verb> <command:noun>AnsibleNotificationTemplate</command:noun> <maml:description> <maml:para>Enable a NotificationTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Enable notification at the specified timings (`Started`, `Success`, `Error` and `Approval`) for the target resource (`Organization`, `Project`, `InventorySource`, `JobTemplate`, `SystemJobTemplate` and `WorkflowJobTemplate`). The timing `Approval` is only available for `Organization` and `WorkflowJobTemplate`.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/organizations/{id}/notification_templates_approvals/` (POST) - `/api/v2/organizations/{id}/notification_templates_error/` (POST) - `/api/v2/organizations/{id}/notification_templates_started/` (POST) - `/api/v2/organizations/{id}/notification_templates_success/` (POST) - `/api/v2/projects/{id}/notification_templates_error/` (POST) - `/api/v2/projects/{id}/notification_templates_started/` (POST) - `/api/v2/projects/{id}/notification_templates_success/` (POST) - `/api/v2/inventory_sources/{id}/notification_templates_error/` (POST) - `/api/v2/inventory_sources/{id}/notification_templates_started/` (POST) - `/api/v2/inventory_sources/{id}/notification_templates_success/` (POST) - `/api/v2/job_templates/{id}/notification_templates_error/` (POST) - `/api/v2/job_templates/{id}/notification_templates_started/` (POST) - `/api/v2/job_templates/{id}/notification_templates_success/` (POST) - `/api/v2/system_job_templates/{id}/notification_templates_error/` (POST) - `/api/v2/system_job_templates/{id}/notification_templates_started/` (POST) - `/api/v2/system_job_templates/{id}/notification_templates_success/` (POST) - `/api/v2/workflow_job_templates/{id}/notification_templates_approvals/` (POST) - `/api/v2/workflow_job_templates/{id}/notification_templates_error/` (POST) - `/api/v2/workflow_job_templates/{id}/notification_templates_started/` (POST) - `/api/v2/workflow_job_templates/{id}/notification_templates_success/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AnsibleNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>NotificationTemplate ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>For</maml:name> <maml:description> <maml:para>The target resource to be enabled the notification.</maml:para> <maml:para>The available resources: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>On</maml:name> <maml:description> <maml:para>Timing of notifications to be enabled.</maml:para> <maml:para>Available timings: - `Started` - `Success` - `Error` - `Approval` (only for `Organization` and `WorkflowJobTemplate` resource)</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Started</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Success</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Approval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>For</maml:name> <maml:description> <maml:para>The target resource to be enabled the notification.</maml:para> <maml:para>The available resources: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>NotificationTemplate ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>On</maml:name> <maml:description> <maml:para>Timing of notifications to be enabled.</maml:para> <maml:para>Available timings: - `Started` - `Success` - `Error` - `Approval` (only for `Organization` and `WorkflowJobTemplate` resource)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>NotificationTemplate ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Enable-AnsibleNotificationTemplate -Id 5 -For (Get-AnsibleJobTemplate -Id 3) -On Success,Error</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleAccessList</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleAccessList</command:noun> <maml:description> <maml:para>Retrieve Users accessible to a resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Users can access to a resource.</maml:para> <maml:para>Implementation of following API: - `/api/v2/instance_groups/{id}/access_list/` - `/api/v2/organizations/{id}/access_list/` - `/api/v2/users/{id}/access_list/` - `/api/v2/projects/{id}/access_list/` - `/api/v2/teams/{id}/access_list/` - `/api/v2/credentials/{id}/access_list/` - `/api/v2/inventories/{id}/access_list/` - `/api/v2/job_templates/{id}/access_list/` - `/api/v2/workflow_job_templates/{id}/access_list/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleAccessList</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `username`, `first_name`, `last_name`, `email`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleAccessList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">InstanceGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Credential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `username`, `first_name`, `last_name`, `email`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleAccessList</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target has access.</maml:para> <maml:para>The resource is accepted following types: - `InstanceGroup` - `Organization` - `User` - `Project` - `Team` - `Credential` - `Inventory` - `JobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `username`, `first_name`, `last_name`, `email`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target has access.</maml:para> <maml:para>The resource is accepted following types: - `InstanceGroup` - `Organization` - `User` - `Project` - `Team` - `Credential` - `Inventory` - `JobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `username`, `first_name`, `last_name`, `email`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target has access.</maml:para> <maml:para>See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleOrganization -Id 2 | Find-AnsibleAccessList Id Type Username Email FirstName LastName IsSuperuser IsSystemAuditor Created Modified LastLogin LdapDn ExternalAccount -- ---- -------- ----- --------- -------- ----------- --------------- ------- -------- --------- ------ --------------- 1 User admin admin@localhost True False 11/04/2023 16:20:25 08/20/2024 17:54:20 08/20/2024 17:54:20 2 User teramako *****@******* tera mako False False 05/21/2024 00:13:43 06/10/2024 22:48:18 06/10/2024 22:48:18</dev:code> <dev:remarks> <maml:para>Retrieve Users with access to the Organization in ID 2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleActivityStream</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleActivityStream</command:noun> <maml:description> <maml:para>Retrieve ActivityStreams.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Activity Streams.</maml:para> <maml:para>Implements following Rest API:</maml:para> <maml:para>- `/api/v2/activity_stream/` - `/api/v2/applications/{id}/activity_stream/` - `/api/v2/tokens/{id}/activity_stream/` - `/api/v2/organizations/{id}/activity_stream/` - `/api/v2/users/{id}/activity_stream/` - `/api/v2/projects/{id}/activity_stream/` - `/api/v2/teams/{id}/activity_stream/` - `/api/v2/credentials/{id}/activity_stream/` - `/api/v2/credential_types/{id}/activity_stream/` - `/api/v2/inventories/{id}/activity_stream/` - `/api/v2/inventory_sources/{id}/activity_stream/` - `/api/v2/groups/{id}/activity_stream/` - `/api/v2/hosts/{id}/activity_stream/` - `/api/v2/job_templates/{id}/activity_stream/` - `/api/v2/jobs/{id}/activity_stream/` - `/api/v2/ad_hoc_commands/{id}/activity_stream/` - `/api/v2/workflow_job_templates/{id}/activity_stream/` - `/api/v2/workflow_jobs/{id}/activity_stream/` - `/api/v2/execution_environments/{id}/activity_stream/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleActivityStream</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `changes`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleActivityStream</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">OAuth2Application</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OAuth2AccessToken</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Credential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CredentialType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AdHocCommand</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExecutionEnvironment</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `changes`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleActivityStream</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `OAuth2Application` - `OAuth2AccessToken` - `Organization` - `User` - `Project` - `Team` - `Credential` - `CredentialType` - `Inventory` - `InventorySource` - `Group` - `Host` - `JobTemplate` - `Job` - `AdHocCommand` - `WorkflowJobTemplate` - `WorkflowJob` - `ExecutionEnvironment`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `changes`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `OAuth2Application` - `OAuth2AccessToken` - `Organization` - `User` - `Project` - `Team` - `Credential` - `CredentialType` - `Inventory` - `InventorySource` - `Group` - `Host` - `JobTemplate` - `Job` - `AdHocCommand` - `WorkflowJobTemplate` - `WorkflowJob` - `ExecutionEnvironment`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `changes`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ActivityStream</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleActivityStream -OrderBy timestamp -Count 3</dev:code> <dev:remarks> <maml:para>Retrieve three ActivityStreams in order by oldest.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleActivityStream -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve ActivityStreams associated with the Organization of ID 1.</maml:para> <maml:para>`Id` and `Type` parameters can also be given from the pipeline, likes following: Get-AnsibleOrganization -Id 1 | Find-AnsibleActivityStream</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleActivityStream</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleAdHocCommandJob</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleAdHocCommandJob</command:noun> <maml:description> <maml:para>Retrieve jobs for AdHocCommand.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of AdHocCommand jobs.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/ad_hoc_commands/` - `/api/v2/inventories/{id}/ad_hoc_commands/` - `/api/v2/hosts/{id}/ad_hoc_commands/` - `/api/v2/groups/{id}/ad_hoc_commands/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleAdHocCommandJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleAdHocCommandJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleAdHocCommandJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Inventory` - `Host` - `Group`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Inventory` - `Host` - `Group`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.AdHocCommand</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleAdHocCommandJob -Search ping</dev:code> <dev:remarks> <maml:para>Serach `ping` jobs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleAdHocCommandJob -Count 2 | Get-AnsibleJobLog</dev:code> <dev:remarks> <maml:para>Retreive two of latest jobs and then get the logs.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleApplication</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleApplication</command:noun> <maml:description> <maml:para>Retrieve (OAuth2) Applications.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Applications.</maml:para> <maml:para>Implementation of following API: - `/api/v2/applications/` - `/api/v2/organizations/{id}/applications/` - `/api/v2/users/{id}/applications/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `User`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `User`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Application</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleApplication</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleApplication -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Applications associated with the Organization of ID 1.</maml:para> <maml:para>`Id` and `Type` parameters can also be given from the pipeline, likes following:</maml:para> <maml:para> Get-AnsibleOrganization -Id 1 | Find-AnsibleApplication</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleCredential</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleCredential</command:noun> <maml:description> <maml:para>Retrieve Credentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Credentials.</maml:para> <maml:para>Implementation of following API: - `/api/v2/credentials/` - `/api/v2/organizations/{id}/credentials/` - `/api/v2/organizations/{id}/galaxy_credentials/` - `/api/v2/users/{id}/credentials/` - `/api/v2/teams/{id}/credentials/` - `/api/v2/credential_types/{id}/credentials/` - `/api/v2/inventory_sources/{id}/credentials/` - `/api/v2/inventory_updates/{id}/credentials/` - `/api/v2/job_templates/{id}/credentials/` - `/api/v2/jobs/{id}/credentials/` - `/api/v2/schedules/{id}/credentials/` - `/api/v2/workflow_job_template_nodes/{id}/credentials/` - `/api/v2/workflow_job_nodes/{id}/credentials/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleCredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Kind"> <maml:name>CredentialTypeKind</maml:name> <maml:description> <maml:para>Filter with CredentialType's `kind` field. This parameter is the same as `-Filter credential_type_ kind _in=...`.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ssh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">vault</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">net</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scm</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cloud</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">registry</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">token</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">insights</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">external</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">kubernetes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">galaxy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cryptography</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CredentialTypeKind[]</command:parameterValue> <dev:type> <maml:name>CredentialTypeKind[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Namespace"> <maml:name>CredentialTypeNamespace</maml:name> <maml:description> <maml:para>Filter with `kind` field. This parameter is the same as `-Filter credential_type_ namespace _in=...`.</maml:para> <maml:para>Examples.) `ssh`, `scm`, `vault`, `net`, `awx`, `openstack`, `vmware`, `satellite6`, `gce`, `azure_rm`, `github_token`, `gitlab_token`, `insights`, `rhv`, `controller`, `kubernetes_bearer_token`, `registry`, `galaxy_api_token`, `gpg_public_key`, `aim`, `aws_secretsmanager_credential`, `azure_kv`, `centrify_vault_kv`, `conjur`, `hashivault_kv`, `hashivault_ssh`, `thycotic_dsv`, `thycotic_tss`</maml:para> <maml:para>> [!NOTE] > The `kind` field of a Credential corresponds to `namespace` field of a CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Galaxy</maml:name> <maml:description> <maml:para>Only affected for an Organization type. Retrieve Galaxy Credentials instead of normal Credentials.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CredentialType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventoryUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Schedule</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplateNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobNode</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Kind"> <maml:name>CredentialTypeKind</maml:name> <maml:description> <maml:para>Filter with CredentialType's `kind` field. This parameter is the same as `-Filter credential_type_ kind _in=...`.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ssh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">vault</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">net</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scm</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cloud</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">registry</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">token</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">insights</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">external</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">kubernetes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">galaxy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cryptography</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CredentialTypeKind[]</command:parameterValue> <dev:type> <maml:name>CredentialTypeKind[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Namespace"> <maml:name>CredentialTypeNamespace</maml:name> <maml:description> <maml:para>Filter with `kind` field. This parameter is the same as `-Filter credential_type_ namespace _in=...`.</maml:para> <maml:para>Examples.) `ssh`, `scm`, `vault`, `net`, `awx`, `openstack`, `vmware`, `satellite6`, `gce`, `azure_rm`, `github_token`, `gitlab_token`, `insights`, `rhv`, `controller`, `kubernetes_bearer_token`, `registry`, `galaxy_api_token`, `gpg_public_key`, `aim`, `aws_secretsmanager_credential`, `azure_kv`, `centrify_vault_kv`, `conjur`, `hashivault_kv`, `hashivault_ssh`, `thycotic_dsv`, `thycotic_tss`</maml:para> <maml:para>> [!NOTE] > The `kind` field of a Credential corresponds to `namespace` field of a CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Galaxy</maml:name> <maml:description> <maml:para>Only affected for an Organization type. Retrieve Galaxy Credentials instead of normal Credentials.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleCredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Kind"> <maml:name>CredentialTypeKind</maml:name> <maml:description> <maml:para>Filter with CredentialType's `kind` field. This parameter is the same as `-Filter credential_type_ kind _in=...`.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ssh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">vault</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">net</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scm</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cloud</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">registry</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">token</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">insights</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">external</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">kubernetes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">galaxy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cryptography</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CredentialTypeKind[]</command:parameterValue> <dev:type> <maml:name>CredentialTypeKind[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Namespace"> <maml:name>CredentialTypeNamespace</maml:name> <maml:description> <maml:para>Filter with `kind` field. This parameter is the same as `-Filter credential_type_ namespace _in=...`.</maml:para> <maml:para>Examples.) `ssh`, `scm`, `vault`, `net`, `awx`, `openstack`, `vmware`, `satellite6`, `gce`, `azure_rm`, `github_token`, `gitlab_token`, `insights`, `rhv`, `controller`, `kubernetes_bearer_token`, `registry`, `galaxy_api_token`, `gpg_public_key`, `aim`, `aws_secretsmanager_credential`, `azure_kv`, `centrify_vault_kv`, `conjur`, `hashivault_kv`, `hashivault_ssh`, `thycotic_dsv`, `thycotic_tss`</maml:para> <maml:para>> [!NOTE] > The `kind` field of a Credential corresponds to `namespace` field of a CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Galaxy</maml:name> <maml:description> <maml:para>Only affected for an Organization type. Retrieve Galaxy Credentials instead of normal Credentials.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `User` - `Team` - `CredentialType` - `InventorySource` - `InventoryUpdate` - `JobTemplate` - `Job` - `Schedule` - `WorkflowJobTemplateNode` - `WorkflowJobNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Kind"> <maml:name>CredentialTypeKind</maml:name> <maml:description> <maml:para>Filter with CredentialType's `kind` field. This parameter is the same as `-Filter credential_type_ kind _in=...`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CredentialTypeKind[]</command:parameterValue> <dev:type> <maml:name>CredentialTypeKind[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Namespace"> <maml:name>CredentialTypeNamespace</maml:name> <maml:description> <maml:para>Filter with `kind` field. This parameter is the same as `-Filter credential_type_ namespace _in=...`.</maml:para> <maml:para>Examples.) `ssh`, `scm`, `vault`, `net`, `awx`, `openstack`, `vmware`, `satellite6`, `gce`, `azure_rm`, `github_token`, `gitlab_token`, `insights`, `rhv`, `controller`, `kubernetes_bearer_token`, `registry`, `galaxy_api_token`, `gpg_public_key`, `aim`, `aws_secretsmanager_credential`, `azure_kv`, `centrify_vault_kv`, `conjur`, `hashivault_kv`, `hashivault_ssh`, `thycotic_dsv`, `thycotic_tss`</maml:para> <maml:para>> [!NOTE] > The `kind` field of a Credential corresponds to `namespace` field of a CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Galaxy</maml:name> <maml:description> <maml:para>Only affected for an Organization type. Retrieve Galaxy Credentials instead of normal Credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `User` - `Team` - `CredentialType` - `InventorySource` - `InventoryUpdate` - `JobTemplate` - `Job` - `Schedule` - `WorkflowJobTemplateNode` - `WorkflowJobNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Credential</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleCredential</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleCredential -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Credentials associated with the Organization of ID 1.</maml:para> <maml:para>`Id` and `Type` parameters can also be given from the pipeline, likes following:</maml:para> <maml:para> Get-AnsibleOrganization -Id 1 | Find-AnsibleCredential</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleCredential -Type Organization -Id 1 -Galaxy</dev:code> <dev:remarks> <maml:para>Retrieve Galaxy Credentials associated with the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleCredentialInputSource</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleCredentialInputSource</command:noun> <maml:description> <maml:para>Retrieve CredentialsInputSources.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of CrdentialInputSources.</maml:para> <maml:para>Implementation of following API: - `/api/v2/credential_input_sources/` - `/api/v2/credentials/{id}/input_sources/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleCredentialInputSource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID or it's object. Retrieve CredenialInputSource which the Credential associated with.</maml:para> <maml:para>> [!TIP] > Can specify `IResource` object. > For example: `-Credential (Get-AnsibleCredential-Id 3)`, `-Credential $creds[1]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID or it's object. Retrieve CredenialInputSource which the Credential associated with.</maml:para> <maml:para>> [!TIP] > Can specify `IResource` object. > For example: `-Credential (Get-AnsibleCredential-Id 3)`, `-Credential $creds[1]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Credential ID or it's object. See: `-Credential` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.CredentialInputSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleCredentialInputSource</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleCredentialInputSource -Credential 10</dev:code> <dev:remarks> <maml:para>Retrieve CredentialInputSources associated with the Credential of ID 10.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredentialInputSource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleCredentialType</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleCredentialType</command:noun> <maml:description> <maml:para>Retrieve CredentialTypes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of CredentialTypes.</maml:para> <maml:para>Implementation of following API: - `/api/v2/credential_types/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleCredentialType</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Filter with `kind` field.</maml:para> <maml:para>Multiple keywords are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ssh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">vault</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">net</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scm</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cloud</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">registry</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">token</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">insights</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">external</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">kubernetes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">galaxy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cryptography</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CredentialTypeKind[]</command:parameterValue> <dev:type> <maml:name>CredentialTypeKind[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Filter with `kind` field.</maml:para> <maml:para>Multiple keywords are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CredentialTypeKind[]</command:parameterValue> <dev:type> <maml:name>CredentialTypeKind[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.CredentialType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleCredentialType</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleCredentialType -Kind ssh,vault</dev:code> <dev:remarks> <maml:para>Retrieve CredentialTypes for `ssh` and `vault`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleExecutionEnvironment</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleExecutionEnvironment</command:noun> <maml:description> <maml:para>Retrieve ExecutionEnvironments.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of ExecutionEnvironment.</maml:para> <maml:para>Implementation of following API: - `/api/v2/execution_environments/` - `/api/v2/organizations/{id}/execution_environments/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleExecutionEnvironment</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID or it's object. Retrieve ExecutionEnvironments which the Organization associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID or it's object. Retrieve ExecutionEnvironments which the Organization associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.ResourceType</maml:name> </dev:type> <maml:description> <maml:para>Input by `Type` property in the pipeline object.</maml:para> <maml:para>Acceptable values: `Organization` (only)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Organization ID or it's object. See: `-Organization` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ExecutionEnvironment</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleExecutionEnvironment</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleExecutionEnvironment -Organization 1</dev:code> <dev:remarks> <maml:para>Retrieve ExecutionEnvironments associated with the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleGroup</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleGroup</command:noun> <maml:description> <maml:para>Retrieve Groups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Groups.</maml:para> <maml:para>Implementation of following API: - `/api/v2/groups/` - `/api/v2/inventories/{id}/groups/` - `/api/v2/inventories/{id}/root_groups/` - `/api/v2/groups/{id}/children/` - `/api/v2/inventory_sources/{id}/groups/` - `/api/v2/hosts/{id}/groups/` - `/api/v2/hosts/{id}/all_groups/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlyParnets</maml:name> <maml:description> <maml:para>List only directly member Groups. Only affected for a Host Type</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlyRoot</maml:name> <maml:description> <maml:para>List only root(Top-level) Groups. Only affected for an Inventory Type</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlyParnets</maml:name> <maml:description> <maml:para>List only directly member Groups. Only affected for a Host Type</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlyRoot</maml:name> <maml:description> <maml:para>List only root(Top-level) Groups. Only affected for an Inventory Type</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Inventory` - `Group` - `InventorySource` - `Host`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlyParnets</maml:name> <maml:description> <maml:para>List only directly member Groups. Only affected for a Host Type</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlyRoot</maml:name> <maml:description> <maml:para>List only root(Top-level) Groups. Only affected for an Inventory Type</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Inventory` - `Group` - `InventorySource` - `Host`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Group</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleGroup</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleGroup -Type Inventory -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Groups associated with the Inventory of ID 1</maml:para> <maml:para>`Id` and `Type` parameters can also be given from the pipeline, likes following: Get-AnsibleInventory -Id 1 | Find-AnsibleGroup</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleGroup -Type Inventory -Id 1 -OnlyRoot</dev:code> <dev:remarks> <maml:para>Retrieve root (top-level) Groups associated with the Inventory of ID 1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleGroup -Type Host -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Groups of which the target Host (ID 1) is directly or indirectly a member.</maml:para> <maml:para>If you need only directly a member, use `-OnlyParents` parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleHost</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleHost</command:noun> <maml:description> <maml:para>Retrieve Hosts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Hosts.</maml:para> <maml:para>Implementation of following API: - `/api/v2/hosts/` - `/api/v2/inventories/{id}/hosts/` - `/api/v2/inventory_sources/{id}/hosts/` - `/api/v2/groups/{id}/hosts/` - `/api/v2/groups/{id}/all_hosts/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleHost</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlyChildren</maml:name> <maml:description> <maml:para>List only directly member group. Only affected for a Group Type</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleHost</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlyChildren</maml:name> <maml:description> <maml:para>List only directly member group. Only affected for a Group Type</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Inventory` - `InventorySource` - `Group`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlyChildren</maml:name> <maml:description> <maml:para>List only directly member group. Only affected for a Group Type</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Inventory` - `InventorySource` - `Group`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Host</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleHost</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleHost -Type Inventory -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Hosts associated with the Inventory of ID 1</maml:para> <maml:para>`Id` and `Type` parameters can also be given from the pipeline, likes following: Get-AnsibleInventory -Id 1 | Find-AnsibleHost</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleHost -Type Group -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Hosts directly or indirectly belonging to the target Group (ID 1).</maml:para> <maml:para>If you need only directly members, use `-OnlyChildren` parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleHostMetric</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleHostMetric</command:noun> <maml:description> <maml:para>Retrieve HostMerics.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of HostMetrics.</maml:para> <maml:para>Implementation of following API: - `/api/v2/host_metrics/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleHostMetric</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `hostname`, `deleted`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `hostname`, `deleted`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.HostMetric</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleHostMetric</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleHostMetric</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleInstance</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleInstance</command:noun> <maml:description> <maml:para>Retrieve Instances.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Instances.</maml:para> <maml:para>Implementation of following API: - `/api/v2/instances/` - `/api/v2/instance_groups/{id}/instances/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleInstance</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InstanceGroup</maml:name> <maml:description> <maml:para>InstanceGroup ID or it's object. Retrieve Instances which the InstanceGroup associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `hostname`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InstanceGroup</maml:name> <maml:description> <maml:para>InstanceGroup ID or it's object. Retrieve Instances which the InstanceGroup associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `hostname`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>InstanceGroup ID or it's object. See `-InstanceGroup` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Instance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInstance</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInstance -InstanceGroup 1</dev:code> <dev:remarks> <maml:para>Retrieve Instances associated with the InstanceGroup of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInstanceGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInstanceGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleInstanceGroup</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleInstanceGroup</command:noun> <maml:description> <maml:para>Retrieve InstanceGroups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of InstanceGroups.</maml:para> <maml:para>Implementation of following API: - `/api/v2/instance_groups/` - `/api/v2/instances/{id}/instance_groups/` - `/api/v2/organizations/{id}/instance_groups/` - `/api/v2/inventories/{id}/instance_groups/` - `/api/v2/job_templates/{id}/instance_groups/` - `/api/v2/schedules/{id}/instance_groups/` - `/api/v2/workflow_job_template_nodes/{id}/instance_groups/` - `/api/v2/workflow_job_nodes/{id}/instance_groups/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleInstanceGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleInstanceGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Instance</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Schedule</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplateNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobNode</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleInstanceGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Instance` - `Organization` - `Inventory` - `JobTemplate` - `Schedule` - `WorkflowJobTemplateNode` - `WorkflowJobNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Instance` - `Organization` - `Inventory` - `JobTemplate` - `Schedule` - `WorkflowJobTemplateNode` - `WorkflowJobNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InstanceGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInstaceGroup</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInstaceGroup -Type Instance -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve InstanceGroups associated with the Instance of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInstanceGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleInventory</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleInventory</command:noun> <maml:description> <maml:para>Retrieve Inventories.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Inventories.</maml:para> <maml:para>Implementation of following API: - `/api/v2/inventories/` - `/api/v2/organizations/{id}/inventories/` - `/api/v2/inventories/{id}/input_inventories/` - `/api/v2/hosts/{id}/smart_inventories/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleInventory</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Filter with the kind of inventory</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Smart</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Constructed</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InventoryKind</command:parameterValue> <dev:type> <maml:name>InventoryKind</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Filter with the kind of inventory</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Smart</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Constructed</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InventoryKind</command:parameterValue> <dev:type> <maml:name>InventoryKind</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleInventory</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Filter with the kind of inventory</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Smart</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Constructed</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InventoryKind</command:parameterValue> <dev:type> <maml:name>InventoryKind</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Inventory` - `Host`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para>Filter with the kind of inventory</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InventoryKind</command:parameterValue> <dev:type> <maml:name>InventoryKind</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Inventory` - `Host`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Inventory</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInventory</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInventory -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Inventories associated with the Organization of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleInventorySource</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleInventorySource</command:noun> <maml:description> <maml:para>Retrieve InventorySources.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of InventorySources.</maml:para> <maml:para>Implementation of following API: - `/api/v2/inventory_sources/` - `/api/v2/projects/{id}/scm_inventory_sources/` - `/api/v2/inventories/{id}/inventory_sources/` - `/api/v2/groups/{id}/inventory_sources/` - `/api/v2/hosts/{id}/inventory_sources/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleInventorySource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleInventorySource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleInventorySource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Project` - `Inventory` - `Group` - `Host`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Project` - `Inventory` - `Group` - `Host`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InventorySource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInventorySource</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInventorySource -Type Inventory -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve InventorySources associated with the Inventory of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleInventoryUpdateJob</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleInventoryUpdateJob</command:noun> <maml:description> <maml:para>Retrieve jobs for InventoryUpdate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of InventoryUpdates which are jobs of InventorySources.</maml:para> <maml:para>Implementation of following API: - `/api/v2/inventory_updates/` - `/api/v2/project_updates/{id}/scm_inventory_updates/` - `/api/v2/inventory_sources/{id}/inventory_updates/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleInventoryUpdateJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleInventoryUpdateJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ProjectUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleInventoryUpdateJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `ProjectUpdate` - `InventorySource`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `ProjectUpdate` - `InventorySource`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InventoryUpdateJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInventoryUpdate</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleInventoryUpdate -Type InventorySource -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve InstanceUpdate jobs associated with the InventorySource of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleInventoryUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleInventoryUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleJob</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleJob</command:noun> <maml:description> <maml:para>Retrieve jobs for JobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of jobs launched from JobTemplates.</maml:para> <maml:para>Implementation of following API: - `/api/v2/jobs/` - `/api/v2/job_templates/{id}/jobs/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>JobTemplate</maml:name> <maml:description> <maml:para>JobTemplate ID or it's object. Filter to jobs in the JobTemplate for the specified ID.</maml:para> <maml:para>> [!TIP] > Can specify `IResource` object. > For example: `-JobTemplate (Get-AnsibleJobTemplate -Id 3)`, `-JobTemplate $jobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by job name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LaunchType</maml:name> <maml:description> <maml:para>Filter with `launch_type` field</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">manual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">relaunch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">callback</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scheduled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">dependency</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">workflow</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">webhook</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">sync</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scm</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">new</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">started</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">pending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">waiting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">running</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">successful</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">canceled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>JobTemplate</maml:name> <maml:description> <maml:para>JobTemplate ID or it's object. Filter to jobs in the JobTemplate for the specified ID.</maml:para> <maml:para>> [!TIP] > Can specify `IResource` object. > For example: `-JobTemplate (Get-AnsibleJobTemplate -Id 3)`, `-JobTemplate $jobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LaunchType</maml:name> <maml:description> <maml:para>Filter with `launch_type` field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by job name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>JobTemplate ID or it's object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobTemplateJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJob -Status running</dev:code> <dev:remarks> <maml:para>Retreive running jobs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJob -JobTemplate 1</dev:code> <dev:remarks> <maml:para>Retrieve jobs associated with the JobTemplate of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleJobEvent</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleJobEvent</command:noun> <maml:description> <maml:para>Retrieve Job Events.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Events for Job, ProjectUpdate, InventoryUpdate, SystemJob and AdHocCommand.</maml:para> <maml:para>Implementation of following API: - `/api/v2/jobs/{id}/job_events/` - `/api/v2/ad_hoc_commands/{id}/events/` - `/api/v2/system_jobs/{id}/events/` - `/api/v2/project_updates/{id}/events/` - `/api/v2/inventory_updates/{id}/events/` - `/api/v2/groups/{id}/job_events/` - `/api/v2/hosts/{id}/ad_hoc_command_events/` - `/api/v2/hosts/{id}/job_events/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleJobEvent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AdHocCommandEvent</maml:name> <maml:description> <maml:para>Retrieve AdHocCommand Events instead of JobTemplate's Events. Only affected for a Host Type</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `counter` (ascending order of `counter`)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["counter"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `stdout`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleJobEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProjectUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventoryUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AdHocCommand</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AdHocCommandEvent</maml:name> <maml:description> <maml:para>Retrieve AdHocCommand Events instead of JobTemplate's Events. Only affected for a Host Type</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `counter` (ascending order of `counter`)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["counter"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `stdout`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleJobEvent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AdHocCommandEvent</maml:name> <maml:description> <maml:para>Retrieve AdHocCommand Events instead of JobTemplate's Events. Only affected for a Host Type</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `counter` (ascending order of `counter`)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["counter"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Target resource object from which to retrieve JobEvent.</maml:para> <maml:para>A resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `SystemJob` : SystemJobTemplate's job - `Host` : Host (Retrieve events for jobs or ad-hoc-command jobs run on the host.) - `Group` : Group (Retrieve events for jobs run on hosts belonging to the group.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `stdout`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AdHocCommandEvent</maml:name> <maml:description> <maml:para>Retrieve AdHocCommand Events instead of JobTemplate's Events. Only affected for a Host Type</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `counter` (ascending order of `counter`)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["counter"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Target resource object from which to retrieve JobEvent.</maml:para> <maml:para>A resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `SystemJob` : SystemJobTemplate's job - `Host` : Host (Retrieve events for jobs or ad-hoc-command jobs run on the host.) - `Group` : Group (Retrieve events for jobs run on hosts belonging to the group.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `stdout`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>The object has `Id` and `Type` properties.</maml:para> <maml:para>And `Type` should be following value: - `Job` - `ProjectUpdate` - `InventoryUpdate` - `SystemJob` - `AdHocCommand` - `Host` - `Group`</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.IJobEventBase</maml:name> </dev:type> <maml:description> <maml:para>JobEvent objects that extend `IJobEventBase` interface. - Job : `Jagabata.Resources.JobEvent` - ProjectUpdate : `Jagabata.Resources.ProjectUpdateJobEvent` - InventoryUpdate : `Jagabata.Resources.InventoryUpdateJobEvent` - SystemJob : `Jagabata.Resources.SystemJobEvent` - AdHocCommand : `Jagabata.Resources.AdHocCommandJobEvent`</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJobEvent -Type Job -Id 10</dev:code> <dev:remarks> <maml:para>Retrieve Events for JobTemplate job of ID 1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJobEvent -Type Host -Id 1 -AdHocCommandEvent</dev:code> <dev:remarks> <maml:para>Retrieve AdHocCommand (not JobTemplate job) Events associated with Host of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleJobHostSummary</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleJobHostSummary</command:noun> <maml:description> <maml:para>Retrieve JobHostSummaries.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of JobHostSummaries for Job, Host or Group.</maml:para> <maml:para>Implementation of following API: - `/api/v2/jobs/{id}/job_host_summaries` - `/api/v2/groups/{id}/job_host_summaries/` - `/api/v2/hosts/{id}/job_host_summaries/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleJobHostSummary</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `host_name`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleJobHostSummary</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `host_name`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleJobHostSummary</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Job` - `Host` - `Group`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `host_name`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Job` - `Host` - `Group`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `host_name`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobHostSummary</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJobHostSummary -Type Job -Id 10</dev:code> <dev:remarks> <maml:para>Retrieve JobHostSummaries associated with the Job of ID 10</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleHost -Id 1 | Find-AnsibleJobHostSummary</dev:code> <dev:remarks> <maml:para>Retrieve JobHostSummaries associated with the Host of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleJobTemplate</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleJobTemplate</command:noun> <maml:description> <maml:para>Retrieve JobTemplates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of JobTemplates.</maml:para> <maml:para>Implementation of following API: - `/api/v2/job_templates/` - `/api/v2/organizations/{id}/job_templates/` - `/api/v2/inventories/{id}/job_templates/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by JobTemplate name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by JobTemplate name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by JobTemplate name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object associated with the resource to be find.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Organization` - `Inventory`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by JobTemplate name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object associated with the resource to be find.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Organization` - `Inventory`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>The object has `Id` and `Type` properties.</maml:para> <maml:para>And `Type` should be following value: - `Organization` - `Inventory`</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJobTemplate</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJobTemplate -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve JobTemplates associated with the Organization of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleJobtemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleLabel</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleLabel</command:noun> <maml:description> <maml:para>Retrieve Labels.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Labels.</maml:para> <maml:para>Implementation of following API: - `/api/v2/labels/` - `/api/v2/inventories/{id}/labels/` - `/api/v2/job_templates/{id}/labels/` - `/api/v2/jobs/{id}/labels/` - `/api/v2/schedules/{id}/labels/` - `/api/v2/workflow_job_templates/{id}/labels/` - `/api/v2/workflow_jobs/{id}/labels/` - `/api/v2/workflow_job_template_nodes/{id}/labels/` - `/api/v2/workflow_job_nodes/{id}/labels/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleLabel</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleLabel</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Schedule</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplateNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobNode</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleLabel</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Inventory` - `JobTemplate` - `Job` - `Schedule` - `WorkflowJobTemplate` - `WorkflowJob` - `WorkflowJobTemplateNode` - `WorkflowJobNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Inventory` - `JobTemplate` - `Job` - `Schedule` - `WorkflowJobTemplate` - `WorkflowJob` - `WorkflowJobTemplateNode` - `WorkflowJobNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Label</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleLabel</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleNotification</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleNotification</command:noun> <maml:description> <maml:para>Retrieve Notifications.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Notifications.</maml:para> <maml:para>Implementation of following API: - `/api/v2/notifications/` - `/api/v2/notification_templates/{id}/notifications/` - `/api/v2/jobs/{id}/notifications/` - `/api/v2/workflow_jobs/{id}/notifications/` - `/api/v2/system_jobs/{id}/notifications/` - `/api/v2/project_updates/{id}/notifications/` - `/api/v2/inventory_updates/{id}/job_templates/` - `/api/v2/ad_hoc_commands/{id}/job_templates/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleNotification</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `subject`, `notification_type`, `body`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotification</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">NotificationTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProjectUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventoryUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AdHocCommand</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `subject`, `notification_type`, `body`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotification</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `NotificationTemplate` - `Job` - `WorkflowJob` - `SystemJob` - `ProjectUpdate` - `InventoryUpdate` - `AdHocCommand`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `subject`, `notification_type`, `body`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `NotificationTemplate` - `Job` - `WorkflowJob` - `SystemJob` - `ProjectUpdate` - `InventoryUpdate` - `AdHocCommand`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `subject`, `notification_type`, `body`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Notification</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleNotification</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleNotification -Type NotificationTemplate -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Notifications associated with the NotificationTemplate of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleNotificationTemplate</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleNotificationTemplate</command:noun> <maml:description> <maml:para>Retrieve NotificationTemplates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of NotificationTemplates.</maml:para> <maml:para>Implementation of following API: - `/api/v2/notification_templates/` - `/api/v2/organizations/{id}/notifications/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID or it's object. Filter to NotoficationTemplates in the Organization for the specified ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID or it's object. Filter to NotoficationTemplates in the Organization for the specified ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Organization ID or it's object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleNotificationTemplate</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleNotificationTemplate -Organization 1</dev:code> <dev:remarks> <maml:para>Retrieve NotificationTemplates associated with the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForApproval</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForStarted</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForError</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForSuccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleNotification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleNotificationTemplateForApproval</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleNotificationTemplateForApproval</command:noun> <maml:description> <maml:para>Retrieve Approval NotificationTemplates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Approval NotificationTemplates enabled in the Organization or WorkflowJobTemplate.</maml:para> <maml:para>Implementation of following API: - `/api/v2/organizations/{id}/notification_templates_approvals/` - `/api/v2/workflow_job_templates/{id}/notification_templates_approvals/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForApproval</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForApproval</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForApproval</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleNotificationTemplateForApproval -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Approval NotificationTemplates enabled in the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForStarted</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForError</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForSuccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleNotificationTemplateForError</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleNotificationTemplateForError</command:noun> <maml:description> <maml:para>Retrieve Error NotificationTemplates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Error NotificationTemplates enabled in the Organization or Template (JobTemplate, WorkflowJobTemplate, Project, InventorySource or SystemJobTemplate).</maml:para> <maml:para>Implementation of following API: - `/api/v2/organizations/{id}/notification_templates_error/` - `/api/v2/job_templates/{id}/notification_templates_error/` - `/api/v2/workflow_job_templates/{id}/notification_templates_error/` - `/api/v2/projects/{id}/notification_templates_error/` - `/api/v2/inventory_sources/{id}/notification_templates_error/` - `/api/v2/system_job_templates/{id}/notification_templates_error/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForError</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForError</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForError</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleNotificationTemplateForError -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Error NotificationTemplates enabled in the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateApproval</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForStarted</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForSuccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleNotificationTemplateForStarted</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleNotificationTemplateForStarted</command:noun> <maml:description> <maml:para>Retrieve Started NotificationTemplates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Started NotificationTemplates enabled in the Organization or Template (JobTemplate, WorkflowJobTemplate, Project, InventorySource or SystemJobTemplate).</maml:para> <maml:para>Implementation of following API: - `/api/v2/organizations/{id}/notification_templates_started/` - `/api/v2/job_templates/{id}/notification_templates_started/` - `/api/v2/workflow_job_templates/{id}/notification_templates_started/` - `/api/v2/projects/{id}/notification_templates_started/` - `/api/v2/inventory_sources/{id}/notification_templates_started/` - `/api/v2/system_job_templates/{id}/notification_templates_started/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForStarted</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForStarted</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForStarted</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleNotificationTemplateForStarted -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Started NotificationTemplates enabled in the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateApproval</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForError</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForSuccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleNotificationTemplateForSuccess</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleNotificationTemplateForSuccess</command:noun> <maml:description> <maml:para>Retrieve Success NotificationTemplates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Success NotificationTemplates enabled in the Organization or Template (JobTemplate, WorkflowJobTemplate, Project, InventorySource or SystemJobTemplate).</maml:para> <maml:para>Implementation of following API: - `/api/v2/organizations/{id}/notification_templates_success/` - `/api/v2/job_templates/{id}/notification_templates_success/` - `/api/v2/workflow_job_templates/{id}/notification_templates_success/` - `/api/v2/projects/{id}/notification_templates_success/` - `/api/v2/inventory_sources/{id}/notification_templates_success/` - `/api/v2/system_job_templates/{id}/notification_templates_success/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForSuccess</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForSuccess</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleNotificationTemplateForSuccess</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleNotificationTemplateForSuccess -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Success NotificationTemplates enabled in the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateApproval</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForStarted</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplateForSuccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleObjectRole</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleObjectRole</command:noun> <maml:description> <maml:para>Retrieve Roles for the target resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Roles for the target resource.</maml:para> <maml:para>Implementation of following API: - `/api/v2/instance_groups/{id}/object_roles/` - `/api/v2/organizations/{id}/object_roles/` - `/api/v2/projects/{id}/object_roles/` - `/api/v2/teams/{id}/object_roles/` - `/api/v2/credentials/{id}/object_roles/` - `/api/v2/inventories/{id}/object_roles/` - `/api/v2/job_templates/{id}/object_roles/` - `/api/v2/workflow_job_templates/{id}/object_roles/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleObjectRole</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `role_field`, `content_type__model`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleObjectRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">InstanceGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Credential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `role_field`, `content_type__model`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleObjectRole</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `InstanceGroup` - `Organization` - `Project` - `Team` - `Credential` - `Inventory` - `JobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `role_field`, `content_type__model`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `InstanceGroup` - `Organization` - `Project` - `Team` - `Credential` - `Inventory` - `JobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `role_field`, `content_type__model`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Role</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleObjectRole -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Roles for the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Grant-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Revoke-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleOrganization</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleOrganization</command:noun> <maml:description> <maml:para>Retrieve Organizations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Organizations.</maml:para> <maml:para>Implementation of following API: - `/api/v2/organizations/` - `/api/v2/users/{id}/organizations/` - `/api/v2/users/{id}/admin_of_organizations/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleOrganization</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by Organization name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Admin</maml:name> <maml:description> <maml:para>Filter to Organizations administerted by the target User.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User ID or it's object. Retrieve Organizations which the User belong to.</maml:para> <maml:para>> [!TIP] > Can specify `IResource` object. > For example: `-Id (Get-AnsibleUser -Id 3)`, `-Id $users[1]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleOrganization</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by Organization name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Admin</maml:name> <maml:description> <maml:para>Filter to Organizations administerted by the target User.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by Organization name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User ID or it's object. Retrieve Organizations which the User belong to.</maml:para> <maml:para>> [!TIP] > Can specify `IResource` object. > For example: `-Id (Get-AnsibleUser -Id 3)`, `-Id $users[1]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>User ID or it's object. See: `-User` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Organization</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleOrganization</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleOrganization -User 1</dev:code> <dev:remarks> <maml:para>Retrieve Organizations which the User of ID 1 belong to.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJobTemplate -User 1 -Admin</dev:code> <dev:remarks> <maml:para>Retrieve Organizations administrered by the User of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleProject</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleProject</command:noun> <maml:description> <maml:para>Retrieve Projects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Projects.</maml:para> <maml:para>Implementation of following API: - `/api/v2/projects/` - `/api/v2/organizations/{id}/projects/` - `/api/v2/users/{id}/projects/` - `/api/v2/teams/{id}/projects/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Team</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `User` - `Team`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `User` - `Team`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Project</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleProject</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleProject -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Projects associated with the Organization of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleProjectUpdateJob</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleProjectUpdateJob</command:noun> <maml:description> <maml:para>Retrieve jobs for ProjectUpdate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of ProjectUpdate jobs.</maml:para> <maml:para>Implementation of following API: - `/api/v2/project_updates/` - `/api/v2/projects/{id}/project_updates/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleProjectUpdateJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project ID or it's object. Filter to ProjectUpdateJobs of the Project for the specified ID.</maml:para> <maml:para>> [!TIP] > Can specify `IResource` object. > For example: `-Project (Get-AnsibleProject -Id 3)`, `-Project $project`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by ProjectUpdate job name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">new</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">started</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">pending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">waiting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">running</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">successful</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">canceled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by ProjectUpdate job name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project ID or it's object. Filter to ProjectUpdateJobs of the Project for the specified ID.</maml:para> <maml:para>> [!TIP] > Can specify `IResource` object. > For example: `-Project (Get-AnsibleProject -Id 3)`, `-Project $project`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Project ID or it's object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ProjectUpdateJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleProjectUpdateJob -Status successful</dev:code> <dev:remarks> <maml:para>Retreive successfully completed ProjectUpdate jobs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleProjectUpdateJob -Project 1</dev:code> <dev:remarks> <maml:para>Retrieve ProjectUpdate jobs associated with the Project of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleRole</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleRole</command:noun> <maml:description> <maml:para>Retrieve Roles all or granted to the target resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve all Roles or the Roles granted to the target (User or Team) if specified.</maml:para> <maml:para>Implementation of following API: - `/api/v2/roles/` - `/api/v2/users/{id}/roles/` - `/api/v2/teams/{id}/roles/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleRole</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `role_field`, `content_type__model`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Team</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `role_field`, `content_type__model`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleRole</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `User` - `Team`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `role_field`, `content_type__model`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `User` - `Team`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `role_field`, `content_type__model`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Role</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleRole</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleRole -Type User -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Roles associated with the User of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleObjectRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Grant-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Revoke-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleSchedule</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleSchedule</command:noun> <maml:description> <maml:para>Retrieve Schedules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Schedules.</maml:para> <maml:para>Implementation of following API: - `/api/v2/schedules/` - `/api/v2/projects/{id}/schedules/` - `/api/v2/inventory_sources/{id}/schedules/` - `/api/v2/job_templates/{id}/schedules/` - `/api/v2/system_job_templates/{id}/schedules/` - `/api/v2/workflow_job_templates/{id}/schedules/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleSchedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleSchedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Schedule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleSchedule</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleSchedule -Type JobTemplate -Id 10</dev:code> <dev:remarks> <maml:para>Retrieve Schedules associated with the JobTemplate of ID 10</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleSystemJob</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleSystemJob</command:noun> <maml:description> <maml:para>Retrieve jobs for SystemJobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of jobs for SystemJobTemplate.</maml:para> <maml:para>Implementation of following API: - `/api/v2/system_jobs/` - `/api/v2/projects/{id}/project_updates/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleSystemJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SystemJobTemplate</maml:name> <maml:description> <maml:para>SystemJobTemplate ID or it's object. Retrieve jobs which the SystemJobTemplate associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">new</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">started</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">pending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">waiting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">running</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">successful</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">canceled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SystemJobTemplate</maml:name> <maml:description> <maml:para>SystemJobTemplate ID or it's object. Retrieve jobs which the SystemJobTemplate associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.ResourceType</maml:name> </dev:type> <maml:description> <maml:para>Input by `Type` property in the pipeline object.</maml:para> <maml:para>Acceptable values: `SystemJobTemplate` (only)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>SystemJobTemplate ID or it's object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.SystemJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleSystemJob</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleSystemJob -Type SystemJobTemplate -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve ProjectUpdate jobs associated with the SystemJobTemplate of ID 1</maml:para> <maml:para>`Id` and `Type` parameters can also be given from the pipeline, likes following: Get-AnsibleSystemJobTemplate -Id 1 | Find-AnsibleSystemJob</maml:para> <maml:para>and also can omit `-Type` parameter: Find-AnsibleSystemJob -Id 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleSystemJobTemplate</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleSystemJobTemplate</command:noun> <maml:description> <maml:para>Retrieve SystemJobTemplates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of SystemJobTemplates.</maml:para> <maml:para>Implementation of following API: - `/api/v2/system_job_templates/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleSystemJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.SystemJobTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleSystemJobTemplate</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleTeam</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleTeam</command:noun> <maml:description> <maml:para>Retrieve Teams.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Teams.</maml:para> <maml:para>Implementation of following API: - `/api/v2/teams/` - `/api/v2/organizations/{id}/teams/` - `/api/v2/users/{id}/teams/` - `/api/v2/projects/{id}/teams/` - `/api/v2/credentials/{id}/owner_teams/` - `/api/v2/roles/{id}/teams/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleTeam</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleTeam</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Credential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Role</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleTeam</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `User` - `Project` - `Credential` - `Role`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `Organization` - `User` - `Project` - `Credential` - `Role`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Team</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleTeam</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleTeam -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Teams associated with the Organization of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleToken</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleToken</command:noun> <maml:description> <maml:para>Retrieve (OAuth2) AccessTokens.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of OAuth2 Access Tokens.</maml:para> <maml:para>Implementation of following API: - `/api/v2/tokens/` - `/api/v2/applications/{id}/tokens/` - `/api/v2/users/{id}/tokens/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleToken</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TokenType</maml:name> <maml:description> <maml:para>Filter by whether the token type is for Application or for Personal.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Both</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Personal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Authorized</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ETokenType</command:parameterValue> <dev:type> <maml:name>ETokenType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"Both"</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">OAuth2Application</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">User</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TokenType</maml:name> <maml:description> <maml:para>Filter by whether the token type is for Application or for Personal.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Both</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Personal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Authorized</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ETokenType</command:parameterValue> <dev:type> <maml:name>ETokenType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"Both"</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleToken</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `OAuth2Application` - `User`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TokenType</maml:name> <maml:description> <maml:para>Filter by whether the token type is for Application or for Personal.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Both</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Personal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Authorized</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ETokenType</command:parameterValue> <dev:type> <maml:name>ETokenType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"Both"</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `OAuth2Application` - `User`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TokenType</maml:name> <maml:description> <maml:para>Filter by whether the token type is for Application or for Personal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ETokenType</command:parameterValue> <dev:type> <maml:name>ETokenType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"Both"</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.OAuth2AccessToken</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleToken</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleToken -Type User -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve AccessTokens associated with the User of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleUnifiedJob</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleUnifiedJob</command:noun> <maml:description> <maml:para>Retrieve Unified Jobs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Jobs which are Job, ProjectUpdate, InventoryUpdate, SystemJob, AdHocCommand or WorkflowJob.</maml:para> <maml:para>Implementation of following API: - `/api/v2/unified_jobs/` - `/api/v2/hosts/{id}/ad_hoc_commands/` - `/api/v2/groups/{id}/ad_hoc_commands/` - `/api/v2/schedules/{id}/jobs/` - `/api/v2/instances/{id}/jobs/` - `/api/v2/instance_groups/{id}/jobs/` - `/api/v2/job_templates/{id}/jobs/` - `/api/v2/workflow_job_templates/{id}/workflow_jobs/` - `/api/v2/projects/{id}/project_updates/` - `/api/v2/inventory_sources/{id}/inventory_updates/` - `/api/v2/system_job_templates/{id}/jobs/` - `/api/v2/inventories/{id}/ad_hoc_commands/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleUnifiedJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`, `job__playbook`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleUnifiedJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Project</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventorySource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Schedule</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Instance</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InstanceGroup</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`, `job__playbook`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleUnifiedJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object associated with the resource to be find.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Group` - `Host` - `Instance` - `InstanceGroup` - `Inventory` - `InventorySource` - `JobTemplate` - `Project` - `Schedule` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`, `job__playbook`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object associated with the resource to be find.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Group` - `Host` - `Instance` - `InstanceGroup` - `Inventory` - `InventorySource` - `JobTemplate` - `Project` - `Schedule` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`, `job__playbook`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>The object has `Id` and `Type` properties.</maml:para> <maml:para>And `Type` should be following value: - `Group` - `Host` - `Instance` - `InstanceGroup` - `Inventory` - `InventorySource` - `JobTemplate` - `Project` - `Schedule` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.IUnifiedJob</maml:name> </dev:type> <maml:description> <maml:para>Unified Job objects which are following instances implemented `IUnifiedJob`: - `Job` : JobTemplate's job - `ProjectUpdate` : Project Update job - `InventoryUpdate` : Inventory Update job - `SystemJob` : SystemJobTemplate's job - `AdHocCommand` : AdHocCommand job - `WorkflowJob` : WorkflowJobTemplate's job</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleUnifiedJob</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleUnifiedJobTemplate</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleUnifiedJobTemplate</command:noun> <maml:description> <maml:para>Retrieve Unified Job Templates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Unified Job Templates which are JobTemplate, Project, InventorySource, SystemJobTemplate or WorkflowJobTemplate.</maml:para> <maml:para>Implementation of following API: - `/api/v2/unified_job_templates/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleUnifiedJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`, `jobtemplate__playbook`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`, `jobtemplate__playbook`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.IUnifiedJobTemplate</maml:name> </dev:type> <maml:description> <maml:para>Unified Job Template objects which are following instances implemented `IUnifiedJobTemplate`: - `JobTemplate` - `Project` - `InventorSource` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleUnifiedJobTemplate</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleUser</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleUser</command:noun> <maml:description> <maml:para>Retrieve Users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of Users.</maml:para> <maml:para>Implementation of following API: - `/api/v2/users/` - `/api/v2/organizations/{id}/users/` - `/api/v2/teams/{id}/users/` - `/api/v2/credentials/{id}/users/` - `/api/v2/roles/{id}/users/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Filter by `user_name` field.</maml:para> <maml:para>Multiple names are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Filter by `email` field.</maml:para> <maml:para>Multiple addresses are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `username`, `first_name`, `last_name`, `email`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Team</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Credential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Role</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Filter by `user_name` field.</maml:para> <maml:para>Multiple names are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Filter by `email` field.</maml:para> <maml:para>Multiple addresses are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `username`, `first_name`, `last_name`, `email`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Filter by `user_name` field.</maml:para> <maml:para>Multiple names are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Filter by `email` field.</maml:para> <maml:para>Multiple addresses are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with. </maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Team` - `Credential` - `Role`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `username`, `first_name`, `last_name`, `email`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Filter by `email` field.</maml:para> <maml:para>Multiple addresses are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with. </maml:para> <maml:para>The resource is accepted following types: - `Organization` - `Team` - `Credential` - `Role`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `username`, `first_name`, `last_name`, `email`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Filter by `user_name` field.</maml:para> <maml:para>Multiple names are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. </maml:para> <maml:para>See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleUser</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleUser -Type Organization -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve Users associated with the Organization of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleWorkflowApprovalRequest</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleWorkflowApprovalRequest</command:noun> <maml:description> <maml:para>Retrieve request jobs for WorkflowApproval.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of WorkflowApproval request jobs.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_approvals/` - `/api/v2/workflow_approval_templates/{id}/approvals/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowApprovalRequest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowApprovalTemplate</maml:name> <maml:description> <maml:para>WorkflowApprovalTemplate ID or it's object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by status.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Pending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Successful</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Failed</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobStatus[]</command:parameterValue> <dev:type> <maml:name>JobStatus[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobStatus[]</command:parameterValue> <dev:type> <maml:name>JobStatus[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowApprovalTemplate</maml:name> <maml:description> <maml:para>WorkflowApprovalTemplate ID or it's object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowApprovalTemplate ID or it's object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowApproval</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowApprovalRequest -Status pending</dev:code> <dev:remarks> <maml:para>Retrieve WorkflowApprovals in the pending status.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Approve-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Deny-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleWorkflowJob</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleWorkflowJob</command:noun> <maml:description> <maml:para>Retrieve jobs for WorkflowJobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of jobs launched from WorkflowJobTemplates or sliced JobTemplates.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_jobs/` - `/api/v2/workflow_job_templates/{id}/workflow_jobs/` - `/api/v2/job_templates/{id}/slice_workflow_jobs/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LaunchType</maml:name> <maml:description> <maml:para>Filter with `launch_type` field</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">manual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">relaunch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">callback</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scheduled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">dependency</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">workflow</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">webhook</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">sync</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scm</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by job name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">new</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">started</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">pending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">waiting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">running</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">successful</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">canceled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LaunchType</maml:name> <maml:description> <maml:para>Filter with `launch_type` field</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">manual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">relaunch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">callback</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scheduled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">dependency</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">workflow</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">webhook</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">sync</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scm</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by job name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">new</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">started</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">pending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">waiting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">running</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">successful</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">canceled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LaunchType</maml:name> <maml:description> <maml:para>Filter with `launch_type` field</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">manual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">relaunch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">callback</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scheduled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">dependency</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">workflow</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">webhook</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">sync</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scm</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by job name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `WorkflowJobTemplate` - `JobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">new</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">started</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">pending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">waiting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">running</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">successful</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">canceled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LaunchType</maml:name> <maml:description> <maml:para>Filter with `launch_type` field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter by job name. The names must be an exact match. (case-sensitive)</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object to which the search target associated with.</maml:para> <maml:para>The resource is accepted following types: - `WorkflowJobTemplate` - `JobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter by `status` field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>Resource object to which the search target associated with. See: `-Resource` parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJob</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJob -Type WorkflowJobTemplate -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve jobs associated with the WorkflowJobTemplate of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleWorkflowJobNode</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleWorkflowJobNode</command:noun> <maml:description> <maml:para>Retrieve nodes for WorkflowJob.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of WorkflowJobNodes.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_nodes/` - `/api/v2/workflow_jobs/{id}/workflow_nodes/` - `/api/v2/workflow_job_nodes/{id}/always_nodes/` - `/api/v2/workflow_job_nodes/{id}/success_nodes/` - `/api/v2/workflow_job_nodes/{id}/failure_nodes/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJobNode</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `unified_job_template_ name`, `unified_job_template _description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJobNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>WorkflowJob ID or it's resource object. Find within the WorkflowJob.</maml:para> <maml:para>> [!TIP] > Can specify an object which has `Type` and `Id`. > Example 1: `-Job (Get-AnsibleWorkflowJob -Id 3)` > Example 2: `-Job @{type="workflowjob"; id=3}` > Example 3: `-Job $workflowJobs[0]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `unified_job_template_ name`, `unified_job_template _description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJobNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Node</maml:name> <maml:description> <maml:para>WorkflowJobNode ID or it's resource object. Search for child nodes linked to that WorkflowJobNode.</maml:para> <maml:para>> [!TIP] > Can specify an object which has `Type` and `Id`. > Example 1: `-Node (Get-AnsibleWorkflowJobNode -Id 10)` > Example 2: `-Node @{type="workflowjobnode"; id=10}` > Example 3: `-Node $nodes[0]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Linked</maml:name> <maml:description> <maml:para>Specifies at which state the WorkflowJobNode is linked.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Always</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Failure</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Success</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkflowJobNodeLinkState</command:parameterValue> <dev:type> <maml:name>WorkflowJobNodeLinkState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `unified_job_template_ name`, `unified_job_template _description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>WorkflowJob ID or it's resource object. Find within the WorkflowJob.</maml:para> <maml:para>> [!TIP] > Can specify an object which has `Type` and `Id`. > Example 1: `-Job (Get-AnsibleWorkflowJob -Id 3)` > Example 2: `-Job @{type="workflowjob"; id=3}` > Example 3: `-Job $workflowJobs[0]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Linked</maml:name> <maml:description> <maml:para>Specifies at which state the WorkflowJobNode is linked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WorkflowJobNodeLinkState</command:parameterValue> <dev:type> <maml:name>WorkflowJobNodeLinkState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Node</maml:name> <maml:description> <maml:para>WorkflowJobNode ID or it's resource object. Search for child nodes linked to that WorkflowJobNode.</maml:para> <maml:para>> [!TIP] > Can specify an object which has `Type` and `Id`. > Example 1: `-Node (Get-AnsibleWorkflowJobNode -Id 10)` > Example 2: `-Node @{type="workflowjobnode"; id=10}` > Example 3: `-Node $nodes[0]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `!id` (descending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["!id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `unified_job_template_ name`, `unified_job_template _description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJob ID or WorkflowJobNode ID. See `-Job` and `-Node` parameters.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobNode</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJobNode</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJobNode -Job 10</dev:code> <dev:remarks> <maml:para>Retrieve nodes associated with the WorkflowJob of ID 10</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJobNode -Node 1 -LinkType Always</dev:code> <dev:remarks> <maml:para>Retrieve WorkflowJobNodes linked to always state of the WorkflowJobNode of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleWorkflowJobTemplate</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleWorkflowJobTemplate</command:noun> <maml:description> <maml:para>Retrieve WorkflowJobTemplates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of WorkflowJobTemplates.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_templates/` - `/api/v2/organizations/{id}/workflow_job_templates/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID or it's object. Search WorkflowJobTemplates which the Organization is associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID or it's object. Search WorkflowJobTemplates which the Organization is associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `name`, `description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Organization ID or it's object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJobTemplate</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJobTemplate -Organization 1</dev:code> <dev:remarks> <maml:para>Retrieve WorkflowJobTemplates associated with the Organization of ID 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-AnsibleWorkflowJobTemplateNode</command:name> <command:verb>Find</command:verb> <command:noun>AnsibleWorkflowJobTemplateNode</command:noun> <maml:description> <maml:para>Retrieve WorkflowJobTemplateNodes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the list of WorkflowJobTemplates.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_template_nodes/` - `/api/v2/workflow_job_templates/{id}/workflow_nodes/` - `/api/v2/workflow_job_template_nodes/{id}/always_nodes/` - `/api/v2/workflow_job_template_nodes/{id}/success_nodes/` - `/api/v2/workflow_job_template_nodes/{id}/failure_nodes/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `unified_job_template_ name`, `unified_job_template _description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Node</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID or it's resource object. Search for child nodes linked to that WorkflowJobTemplateNode.</maml:para> <maml:para>> [!TIP] > Can specify an object which has `Type` and `Id`. > Example 1: `-Node (Get-AnsibleWorkflowJobTemplateNode -Id 10)` > Example 2: `-Node @{type="workflowjobtemplatenode"; id=10}` > Example 3: `-Node $nodes[0]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Linked</maml:name> <maml:description> <maml:para>Specifies at which state the WorkflowJobTemplateNode is linked.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Always</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Failure</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Success</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkflowJobNodeLinkState</command:parameterValue> <dev:type> <maml:name>WorkflowJobNodeLinkState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `unified_job_template_ name`, `unified_job_template _description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID or it's resource object. Find within the WorkflowJobTemplate.</maml:para> <maml:para>> [!TIP] > Can specify an object which has `Type` and `Id`. > Example 1: `-Template (Get-AnsibleWorkflowJobTemplate -Id 3)` > Example 2: `-Template @{type="workflowjobtemplate"; id=3}` > Example 3: `-Template $wjt[0]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `unified_job_template_ name`, `unified_job_template _description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve resources from all pages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number to retrieve per page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filtering various fields.</maml:para> <maml:para>For examples: - `name__icontains=test`: "name" field contains "test" (case-insensitive). - `"name_ in=test,demo", created _gt=2024-01-01`: "name" field is "test" or "demo" and created after 2024-01-01. - `@{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }`: "name" field NOT contains "test"</maml:para> <maml:para>For more details, see about_Jagabata.psm_Filter_parameter (about_Jagabata.psm_Filter_parameter.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValueCollection</command:parameterValue> <dev:type> <maml:name>NameValueCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Linked</maml:name> <maml:description> <maml:para>Specifies at which state the WorkflowJobTemplateNode is linked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WorkflowJobNodeLinkState</command:parameterValue> <dev:type> <maml:name>WorkflowJobNodeLinkState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Node</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID or it's resource object. Search for child nodes linked to that WorkflowJobTemplateNode.</maml:para> <maml:para>> [!TIP] > Can specify an object which has `Type` and `Id`. > Example 1: `-Node (Get-AnsibleWorkflowJobTemplateNode -Id 10)` > Example 2: `-Node @{type="workflowjobtemplatenode"; id=10}` > Example 3: `-Node $nodes[0]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Retrieve list in the specified orders. Use `!` prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(`,`).</maml:para> <maml:para>Default value: `id` (ascending order of ID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>["id"]</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>Page number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Search</maml:name> <maml:description> <maml:para>Search words. (case-insensitive)</maml:para> <maml:para>Target fields: `unified_job_template_ name`, `unified_job_template _description`</maml:para> <maml:para>Multiple words are available by separating with a comma(`,`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID or it's resource object. Find within the WorkflowJobTemplate.</maml:para> <maml:para>> [!TIP] > Can specify an object which has `Type` and `Id`. > Example 1: `-Template (Get-AnsibleWorkflowJobTemplate -Id 3)` > Example 2: `-Template @{type="workflowjobtemplate"; id=3}` > Example 3: `-Template $wjt[0]`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplate ID or WorkflowJobTemplateNode ID. See `-Template` and `-Node` parameters.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplateNode</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJobTemplateNode</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJobTemplateNode -Template 1</dev:code> <dev:remarks> <maml:para>Retrieve WorkflowJobTemplateNodes associated with the WorkflowJobTemplate of ID 1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJobTemplateNode -Node 1 -For Always</dev:code> <dev:remarks> <maml:para>Retrieve WorkflowJobTemplateNodes linked to always state of the WorkflowJobTemplateNode of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleActivityStream</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleActivityStream</command:noun> <maml:description> <maml:para>Retrieves ActivityStreams by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retreive ActivityStreams by the specified ID.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/activity_stream/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleActivityStream</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more ActivityStreams.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more ActivityStreams.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ActivityStream</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleActivityStream -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve an ActivityStream for Database ID 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> 1..4 | Get-AnsibleActivityStream</dev:code> <dev:remarks> <maml:para>Retrieve ActivityStreams with ID numbers 1 though 4.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleActivityStream</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleAdHocCommandJob</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleAdHocCommandJob</command:noun> <maml:description> <maml:para>Retrieve AdHocCommand job details by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve AdHocCommand jobs by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/ad_hoc_commands/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleAdHocCommandJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more AdHocCommand jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more AdHocCommand jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.AdHocCommand+Detail</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleAdHocCommandJob -Id 10</dev:code> <dev:remarks> <maml:para>Retrieve an ActivityStream for Database ID 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> 10..15 | Get-AnsibleAdHocCommandJob</dev:code> <dev:remarks> <maml:para>Retrieve AdHocCommand jobs with ID numbers 10 though 15.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleApiConfig</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleApiConfig</command:noun> <maml:description> <maml:para>Get loaded config data currently.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get this module's config using currently. The config has AWX/AnsibleTower URL, file path and token value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleApiConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.ApiConfig</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleApiConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-AnsibleApiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Switch-AnsibleApiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleApiHelp</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleApiHelp</command:noun> <maml:description> <maml:para>Get and show Ansible's API Help.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve API Document and show for the specified URL path using AWX/AnsibleTower Rest API by `OPTIONS` method.</maml:para> <maml:para>See the following URL for a list of API URL paths: - `https://ansible.readthedocs.io/projects/awx/en/latest/rest_api/api_ref.html`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleApiHelp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>URL path of the Rest API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>URL path of the Rest API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ApiHelp</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleApiHelp /api/v2/jobs/ Name : Job List Description : List Jobs: Make a GET request to this resource to retrieve the list of jobs. (snip) Renders : application/json text/html Parses : application/json Actions : GET Types : job SearchFields : description name RelatedSearchFields : job_host_summaries modified_by (snip) schedule instance_group ObjectRoles : MaxPageSize : 200</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleApplication</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleApplication</command:noun> <maml:description> <maml:para>Retrieve Applications by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Implementation of following API:</maml:para> <maml:para>* `/api/v2/applications/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Applications.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Applications.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Application</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleApplication 1</dev:code> <dev:remarks> <maml:para>Retrieve an Application of ID `1`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleConfig</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleConfig</command:noun> <maml:description> <maml:para>Retrieve various sitewide configuration settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve site configuration settings and general information.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/config/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Config</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleConfig TimeZone : UTC LicenseInfo : { LicenseType = open, ValidKey = True, SubscriptionName = OPEN, ProductName = AWX } Version : 23.3.1 Eula : ConfigAnalyticsStatus : AnalyticsCollectors : {[config, { ... }], [counts, { ... }], [cred_type_counts, { ... }], [events_table, { ... }]…} BecomeMethods : {sudo Sudo, su Su, pbrun Pbrun, pfexec Pfexec…} UiNext : True ProjectBaseDir : /var/lib/awx/projects/ ProjectLocalPaths : {} CustomVirtualenvs : {}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleCredential</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleCredential</command:noun> <maml:description> <maml:para>Retrieve Credentials by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Credentials by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/credentials/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Credential</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleCredential -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a Credential for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleCredentialInputSource</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleCredentialInputSource</command:noun> <maml:description> <maml:para>Retrieve CredentialInputSources by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve CredentialInputSources by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/credential_input_sources/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleCredentialInputSource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more CredentialInputSources.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more CredentialInputSources.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.CredentialInputSource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleCredentialInputSource -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a CredentialInputSource for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleCredentialInputSource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleCredentialType</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleCredentialType</command:noun> <maml:description> <maml:para>Retrieve CredentialTypes by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve CredentialTypes by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/credential_types/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleCredentialType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.CredentialType</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleCredentialType -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a CredentialType for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleDashboard</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleDashboard</command:noun> <maml:description> <maml:para>Retrieve Dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve AWX/AnsibleTower Dashboard data.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/dashboard/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleDashboard</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Dashboard</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleDashboard Inventories : Total TotalWithInventorySource JobFailed InventoryFailed ----- ------------------------ --------- --------------- 4 1 0 0 InventorySources : Label Total Failed ----- ----- ------ Amazon EC2 0 0 Groups : Total InventoryFailed ----- --------------- 5 0 Hosts : Total Failed ----- ------ 4 0 Projects : Total Failed ----- ------ 3 0 ScmTypes : Label Total Failed ----- ----- ------ Git 2 0 Subversion 0 0 Remote Archive 0 0 Users : Total ----- 3 Organizations : Total ----- 2 Teams : Total ----- 1 JobTemplates : Total ----- 6</dev:code> <dev:remarks> <maml:para>Show Dashboard</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleExecutionEnvironment</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleExecutionEnvironment</command:noun> <maml:description> <maml:para>Retrieve ExecutionEnvironments by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve ExecutionEnvironments by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/execution_environments/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleExecutionEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more ExecutionEnvironments.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more ExecutionEnvironments.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ExecutionEnvironment</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleExecutionEnvironment -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve an ExecutionEnvironment for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleGroup</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleGroup</command:noun> <maml:description> <maml:para>Retrieve Groups by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Groups by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/groups/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Group</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleGroup -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a Group for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleHost</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleHost</command:noun> <maml:description> <maml:para>Retrieve Hosts by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Hosts by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/hosts/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Host</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleHost -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a Host for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleHostFactsCache</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleHostFactsCache</command:noun> <maml:description> <maml:para>Retrieve Ansible Facts for a Host.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Ansible Facts for a Host.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/hosts/{id}/ansible_facts/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleHostFactsCache</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of Host ID(s).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of Host ID(s).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more Host ID(s).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.Dictionary`2[[System.String],[System.Object]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleHostFactsCache -Id 1 Key Value --- ----- ansible_dns {[search, System.Object[]], [options, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [nameservers, System.Object[]]} ansible_env {[_, /usr/bin/python3], [PWD, /runner/project], [HOME, /root], [PATH, /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin]…} ansible_lsb {} ansible_lvm N/A ansible_fips False ansible_fqdn awx_1 module_setup True ansible_local {} gather_subset {all} ansible_domain ansible_kernel 5.15.153.1-microsoft-standard-WSL2 (snip)</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleHostMetric</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleHostMetric</command:noun> <maml:description> <maml:para>Retrieve HostMetrics by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve HostMetrics by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/host_metrics/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleHostMetric</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more HostMetrics.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more HostMetrics.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.HostMetric</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleHostMetric -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a HostMetric for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleHostMetric</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleInstance</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleInstance</command:noun> <maml:description> <maml:para>Retrieve Instances by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Instances by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/insertions/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Instances.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Instances.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Instance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleInstance -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve an Instance for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleInstanceGroup</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleInstanceGroup</command:noun> <maml:description> <maml:para>Retrieve InstanceGroups by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve InstanceGroups by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/instance_groups/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleInstanceGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more InstanceGroups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more InstanceGroups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InstanceGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleInstanceGroup -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve an InstanceGroup for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleInstanceGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleInventory</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleInventory</command:noun> <maml:description> <maml:para>Retrieve Inventories by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Inventories by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventories/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Inventories.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Inventories.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Inventory</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleInventory -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve an Inventory for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleInventoryFile</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleInventoryFile</command:noun> <maml:description> <maml:para>Retrieve inventory files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve inventory files and directories available within this project, not comprehensive.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/projects/{id}/inventories/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleInventoryFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Path string for inventory files and directories.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleInventoryFile -Id 3 inventory/hosts.ini inventory/hosts_2.ini</dev:code> <dev:remarks> <maml:para>Retrieve inventory files within the Project in ID 3.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleProject -Id 3 | Get-AnsibleInventoryFile inventory/hosts.ini inventory/hosts_2.ini</dev:code> <dev:remarks> <maml:para>Retrieve inventory files from pipeline inputed Project object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleInventorySource</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleInventorySource</command:noun> <maml:description> <maml:para>Retrieve InventorySources by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve InventorySources by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventory_sources/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleInventorySource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more InventorySources.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more InventorySources.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InventorySource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleInventorySource -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve an InventorySource for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleInventoryUpdateJob</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleInventoryUpdateJob</command:noun> <maml:description> <maml:para>Retrieve InventoryUpdate job details by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve InventoryUpdate job details by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventory_updates/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleInventoryUpdateJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more InventoryUpdate jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more InventoryUpdate jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InventoryUpdateJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleInventoryUpdateJob -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve an InventoryUpdate job for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleJob</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleJob</command:noun> <maml:description> <maml:para>Retrieve JobTemplate's job details by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve JobTemplate's job details by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/jobs/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobTemplateJob+Detail</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleJob -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a JobTemplate's job detail for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleJobHostSummary</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleJobHostSummary</command:noun> <maml:description> <maml:para>Retrieve JobHostSummaries by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve JobHostSummaries by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/job_host_summaries/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleJobHostSummary</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more JobHostSummary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more JobHostSummary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobHostSummary</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleJobHostSummary -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a JobHostSummary for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleJobHostSummary</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleJobLog</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleJobLog</command:noun> <maml:description> <maml:para>Retrieve job logs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve job logs for UnifiedJob(s) and output to STDOUT or download to files for each jobs. The job's information is added to the file when downloading.</maml:para> <maml:para>You can choose log format with `-Format` parameter: - `txt` : Plain text (default) - `ansi`: Plain text with ANSI color (need Terminal supported VT100 escape sequence) - `html`: HTML format - `json`: JSON format (only affected when downloding. otherwise same as `ansi`)</maml:para> <maml:para>"UnifiedJob(s)" referes to following jobs: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `WorkflowJob` : WorkflowJobTemplate's job - `SystemJob` : SystemJobTemplate's job</maml:para> <maml:para>When the specified job is a WorkflowJob, retrieve job logs for each of its nodes.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/jobs/{id}/stdout/` - `/api/v2/project_updates/{id}/stdout/` - `/api/v2/inventory_updates/{id}/stdout/` - `/api/v2/ad_hoc_commands/{id}/stdout/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleJobLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Dark</maml:name> <maml:description> <maml:para>Get log with darck(black) background color. This would only affect HTML format.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Log format:</maml:para> <maml:para>- `txt` : Plain text (default) - `ansi`: Plain text with ANSI color (need Terminal supported VT100 escape sequence) - `html`: HTML format - `json`: JSON format (only affected when downloding. otherwise same as `ansi`) The only exception is SystemJob, which can only be downloaded as text format.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">txt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ansi</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">html</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobLogFormat</command:parameterValue> <dev:type> <maml:name>JobLogFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AnsibleJobLog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target UnifiedJob.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProjectUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventoryUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AdHocCommand</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Unified Job specified by the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Dark</maml:name> <maml:description> <maml:para>Get log with darck(black) background color. This would only affect HTML format.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Download</maml:name> <maml:description> <maml:para>Indicates download to files and download to the argument value's directory.</maml:para> <maml:para>The file name format: `<job-ID>.<format>`. eg.) 10.txt, 10.ansi, 10.html, 10.json</maml:para> <maml:para>The only exception is SystemJob, which can only be downloaded as TEXT format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DirectoryInfo</command:parameterValue> <dev:type> <maml:name>DirectoryInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Log format:</maml:para> <maml:para>- `txt` : Plain text (default) - `ansi`: Plain text with ANSI color (need Terminal supported VT100 escape sequence) - `html`: HTML format - `json`: JSON format (only affected when downloding. otherwise same as `ansi`) The only exception is SystemJob, which can only be downloaded as text format.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">txt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ansi</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">html</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobLogFormat</command:parameterValue> <dev:type> <maml:name>JobLogFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AnsibleJobLog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>UnifiedJob resource object from which to retrieve log.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `WorkflowJob` : WorkflowJobTemplate's job - `SystemJob` : SystemJobTemplate's job</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Dark</maml:name> <maml:description> <maml:para>Get log with darck(black) background color. This would only affect HTML format.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Download</maml:name> <maml:description> <maml:para>Indicates download to files and download to the argument value's directory.</maml:para> <maml:para>The file name format: `<job-ID>.<format>`. eg.) 10.txt, 10.ansi, 10.html, 10.json</maml:para> <maml:para>The only exception is SystemJob, which can only be downloaded as TEXT format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DirectoryInfo</command:parameterValue> <dev:type> <maml:name>DirectoryInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Log format:</maml:para> <maml:para>- `txt` : Plain text (default) - `ansi`: Plain text with ANSI color (need Terminal supported VT100 escape sequence) - `html`: HTML format - `json`: JSON format (only affected when downloding. otherwise same as `ansi`) The only exception is SystemJob, which can only be downloaded as text format.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">txt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ansi</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">html</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobLogFormat</command:parameterValue> <dev:type> <maml:name>JobLogFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AnsibleJobLog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target UnifiedJob.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProjectUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventoryUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AdHocCommand</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Unified Job specified by the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Dark</maml:name> <maml:description> <maml:para>Get log with darck(black) background color. This would only affect HTML format.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Log format:</maml:para> <maml:para>- `txt` : Plain text (default) - `ansi`: Plain text with ANSI color (need Terminal supported VT100 escape sequence) - `html`: HTML format - `json`: JSON format (only affected when downloding. otherwise same as `ansi`) The only exception is SystemJob, which can only be downloaded as text format.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">txt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ansi</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">html</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobLogFormat</command:parameterValue> <dev:type> <maml:name>JobLogFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AnsibleJobLog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>UnifiedJob resource object from which to retrieve log.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `WorkflowJob` : WorkflowJobTemplate's job - `SystemJob` : SystemJobTemplate's job</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Dark</maml:name> <maml:description> <maml:para>Get log with darck(black) background color. This would only affect HTML format.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Log format:</maml:para> <maml:para>- `txt` : Plain text (default) - `ansi`: Plain text with ANSI color (need Terminal supported VT100 escape sequence) - `html`: HTML format - `json`: JSON format (only affected when downloding. otherwise same as `ansi`) The only exception is SystemJob, which can only be downloaded as text format.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">txt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ansi</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">html</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobLogFormat</command:parameterValue> <dev:type> <maml:name>JobLogFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Dark</maml:name> <maml:description> <maml:para>Get log with darck(black) background color. This would only affect HTML format.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Download</maml:name> <maml:description> <maml:para>Indicates download to files and download to the argument value's directory.</maml:para> <maml:para>The file name format: `<job-ID>.<format>`. eg.) 10.txt, 10.ansi, 10.html, 10.json</maml:para> <maml:para>The only exception is SystemJob, which can only be downloaded as TEXT format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DirectoryInfo</command:parameterValue> <dev:type> <maml:name>DirectoryInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Log format:</maml:para> <maml:para>- `txt` : Plain text (default) - `ansi`: Plain text with ANSI color (need Terminal supported VT100 escape sequence) - `html`: HTML format - `json`: JSON format (only affected when downloding. otherwise same as `ansi`) The only exception is SystemJob, which can only be downloaded as text format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobLogFormat</command:parameterValue> <dev:type> <maml:name>JobLogFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Unified Job specified by the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>UnifiedJob resource object from which to retrieve log.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `WorkflowJob` : WorkflowJobTemplate's job - `SystemJob` : SystemJobTemplate's job</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target UnifiedJob.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>The object has `Id` and `Type` properties.</maml:para> <maml:para>And `Type` should be following value: - `Job` - `ProjectUpdate` - `InventoryUpdate` - `SystemJob` - `WorkflowJob` - `AdHocCommand`</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Job log string. (when not downloading)</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para>Downloaded file objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleJobLog @{ type = "job"; id = 10 } ==> [10] Job PLAY [Hello World Sample] ****************************************************** TASK [Gathering Facts] ********************************************************* ok: [localhost] TASK [Hello Message] *********************************************************** ok: [localhost] => { "msg": "Hello World!" } PLAY RECAP ********************************************************************* localhost : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0</dev:code> <dev:remarks> <maml:para>Show the log for Job of ID 10 as text format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleJobLog @{ type = job; id = 10 } -Format html -Download . Mode LastWriteTime Length Name ---- ------------- ------ ---- -a--- 2024/08/05 14:20 4081 10.html</dev:code> <dev:remarks> <maml:para>Download log to the current directory as HTML format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJob -Status successful,failed -Count 3 | Get-AnsibleJobLog -Format ansi ==> [13] Job (snip) ==> [12] Job (snip) ==> [11] Job (snip)</dev:code> <dev:remarks> <maml:para>Retrieve the three jobs finished as successfull or failed, and show the their logs.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleProjectUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleJobStatistics</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleJobStatistics</command:noun> <maml:description> <maml:para>Retrieve statistics for job runs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve aggregate statistics about job runs suitable for graphing.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/dashboard/graphs/jobs/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleJobStatistics</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Period</maml:name> <maml:description> <maml:para>Period of statistics to be retrieved. (default: `month`)</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">month</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">two_weeks</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">week</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">day</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Job type of statistics to be retrieved. (default: `all`)</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">all</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">inv_sync</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">playbook_run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">scm_update</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Job type of statistics to be retrieved. (default: `all`)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Period</maml:name> <maml:description> <maml:para>Period of statistics to be retrieved. (default: `month`)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobStatistics</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleJobStatistics Successful Failed ---------- ------ Date Count Date Count ---- ----- ---- ----- 07/24/2024 0 07/24/2024 0 07/25/2024 0 07/25/2024 1 07/26/2024 0 07/26/2024 0 ...</dev:code> <dev:remarks> <maml:para>Retrieve statistics on all jobs for a month.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleJobTemplate</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleJobTemplate</command:noun> <maml:description> <maml:para>Retrieve JobTemplates by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve JobTemplates by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/job_template/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more JobTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more JobTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleJobTemplate -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a JobTemplate for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleJobtemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleLabel</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleLabel</command:noun> <maml:description> <maml:para>Retrieve Labels by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Labels by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/labels/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleLabel</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Labels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Labels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Label</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleLabel -Id 1</dev:code> <dev:remarks> <maml:para>Retrieve a Label for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleMe</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleMe</command:noun> <maml:description> <maml:para>Retrieve the current user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the current user.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/me/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleMe</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleMe Id Type Username Email FirstName LastName IsSuperuser IsSystemAuditor Created Modified LastLogin LdapDn ExternalAccount -- ---- -------- ----- --------- -------- ----------- --------------- ------- -------- --------- ------ --------------- 1 User admin admin@localhost True False 2023/11/04 16:20:25 2024/08/02 16:26:10 2024/08/02 16:26:10</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleMetric</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleMetric</command:noun> <maml:description> <maml:para>Retrieve Metrics.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Metrics.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/metrics/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleMetric</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Cmdlets.MetricItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleMetric Description Type SampleType Value Labels ----------- ---- ---------- ----- ------ AWX System Information gauge 1 external_logger_enabled False… Number of organizations gauge 2 Number of users gauge 3 (snip) Number of active tasks in the worker pool when last task was submitted gauge 1 node awx_1 Highest number of workers in worker pool in last collection interval, about 20s gauge 4 node awx_1 Fraction of time (in last collection interval) dispatcher was able to receive messages gauge 0.997828014517918 node awx_1</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleNotification</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleNotification</command:noun> <maml:description> <maml:para>Retrieve Notifications by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Notifications by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/notifications/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleNotification</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Notifications.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Notifications.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Notification</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleNotification -Id 1 | Format-List Id : 1 Type : Notification Created : 2024/07/18 16:41:05 Modified : 2024/07/18 16:41:05 NotificationTemplate : 1 Name : TestNotification Description : Test Status : Successful Error : NotificationsSent : 1 NotificationType : Slack Recipients : ['#proj-ansible'] Subject : The approval node "Approval" was approved. http://******* Body :</dev:code> <dev:remarks> <maml:para>Retrieve a Notification for Database ID 1 and display as List format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleNotification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleNotificationTemplate</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleNotificationTemplate</command:noun> <maml:description> <maml:para>Retrieve NotificationTemplates by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve NotificationTemplates by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/notification_templates/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more NotificationTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more NotificationTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleNotificationTemplate 1 | Format-List Id : 1 Type : NotificationTemplate Created : 2024/06/08 22:38:16 Modified : 2024/06/08 23:40:23 Name : TestNotification Description : Test Organization : 2 OrganizationName : TestOrg NotificationType : Slack NotificationConfiguration : {[token, $encrypted$], [channels, ["#proj-ansible"]], [hex_color, ]} StartMessage : NMessage { Body = , Message = } SuccessMessage : NMessage { Body = , Message = } ErrorMessage : NMessage { Body = , Message = } ApprovedMessage : NMessage { Body = , Message = } DeniedMessage : NMessage { Body = , Message = } RunningMessage : NMessage { Body = , Message = }</dev:code> <dev:remarks> <maml:para>Retrieve a NotificationTemplate for Database ID 1 and display as List format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleOrganization</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleOrganization</command:noun> <maml:description> <maml:para>Retrieve Organizations by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Organizations by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/organizations/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleOrganization</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Organizations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Organizations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Organization</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleOrganization -Id 1 | Format-List Id : 1 Type : Organization Created : 2023/11/04 16:20:27 Modified : 2023/11/04 16:20:27 Name : Default Description : MaxHosts : 0 CustomVirtualenv : InventoryCount : 1 TeamCount : 0 UserCount : 1 JobTemplateCount : 2 AdminCount : 0 ProjectCount : 1 DefaultEnvironment :</dev:code> <dev:remarks> <maml:para>Retrieve an Organization for Database ID 1 and display as List format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsiblePing</command:name> <command:verb>Get</command:verb> <command:noun>AnsiblePing</command:noun> <maml:description> <maml:para>Retrieve some basic information about the instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A simple view that reports very basic information about this instance, which is acceptable to be public information.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/ping/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsiblePing</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Ping</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsiblePing HA : False Version : 23.3.1 ActiveNode : awx_1 InstallUuid : 0aa779f2-fe62-4252-a01e-e163b75e12ec Instances : {{ Node = awx_1, NodeType = hybrid, Uuid = c327e3bc-807b-4670-acc2-925f6913c421, Heartbeat = 2024-08-05T08:17:20.194459Z, Capacity = 138, Version = 23.3.1 }} InstanceGroups : {{ Name = controlplane, Capacity = 138, Instances: [awx_1] }, { Name = default, Capacity = 138, Instances: [awx_1] }}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsiblePlaybook</command:name> <command:verb>Get</command:verb> <command:noun>AnsiblePlaybook</command:noun> <maml:description> <maml:para>Retrieve playbooks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve playbooks available associated with the Project.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/projects/{id}/playbooks/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsiblePlaybook</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Path string for playbook.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsiblePlaybook -Id 3 hello_world.yml playbooks/demo_1.yml playbooks/demo_2.yml playbooks/demo_3.yml</dev:code> <dev:remarks> <maml:para>Retrieve playbooks associated with the Project in ID 3.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleProject -Id 3 | Get-AnsiblePlaybook hello_world.yml playbooks/demo_1.yml playbooks/demo_2.yml playbooks/demo_3.yml</dev:code> <dev:remarks> <maml:para>Retrieve playbooks from pipeline inputed Project object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleProject</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleProject</command:noun> <maml:description> <maml:para>Retrieve Projects by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Projects by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/projects/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Project</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleProject -Id 6 Id Type Name Description Status Modified LastJobRun NextJobRun Options Note -- ---- ---- ----------- ------ -------- ---------- ---------- ------- ---- 6 Project Demo Project Successful 2023/11/04 16:20:27 2024/07/02 0:01:13 None {[Scm, [git]https://github.com/ansible/ansible-tower-samples], [Branch, ]}</dev:code> <dev:remarks> <maml:para>Retrieve a Project for Database ID 6.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleProjectUpdateJob</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleProjectUpdateJob</command:noun> <maml:description> <maml:para>Retrieve ProjectUpdate job details by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve ProjectUpdate job details by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/project_updates/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleProjectUpdateJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more ProjectUpdate jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more ProjectUpdate jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ProjectUpdateJob+Detail</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleProjectUpdateJob -Id 10 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 10 ProjectUpdate Demo Project Run Sync Successful 2024/07/11 9:27:49 1.39 [project][6]Demo Project [6][git]Demo Project {[Branch, ], [Revision, ****], [Url, https://***]}</dev:code> <dev:remarks> <maml:para>Retrieve a ProjectUpdate job for Database ID 10.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleRole</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleRole</command:noun> <maml:description> <maml:para>Retrieve Roles by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Roles by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/roles/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Role</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleRole -Id 1 Id Type Name Description ResourceId ResourceType ResourceName -- ---- ---- ----------- ---------- ------------ ------------ 1 Role System Administrator Can manage all aspects of the system</dev:code> <dev:remarks> <maml:para>Retrieve a Role for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Grant-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Revoke-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleSchedule</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleSchedule</command:noun> <maml:description> <maml:para>Retrieve Schedules by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Schedules by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/schedules/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Schedules.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Schedules.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Schedule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleSchedule -Id 1 | Format-List Id : 1 Type : Schedule Created : 2023/11/04 16:19:08 Modified : 2023/11/04 16:19:08 Name : Cleanup Job Schedule Description : Automatically Generated Schedule Enabled : True Rrule : DTSTART:20231104T071908Z RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=SU Dtstart : Dtend : NextRun : 2024/08/11 16:19:08 Timezone : Until : UnifiedJobTemplate : 1 UnifiedJobTemplateName : Cleanup Job Details UnifiedJobType : SystemJob ExtraData : {[days, 120]} Inventory : ScmBranch : JobType : JobTags : SkipTags : Limit : DiffMode : Verbosity : ExecutionEnvironment : Forks : JobSliceCount : Timeout :</dev:code> <dev:remarks> <maml:para>Retrieve a Schedule for Database ID 1 and display as List format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-AnsibleSchendule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleSetting</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleSetting</command:noun> <maml:description> <maml:para>Retrieve Settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Settings of the specified name or retreive a list of its names when ommited.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/settings/` - `/api/v2/settings/{category_slug}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleSetting</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The setting name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The setting name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Setting</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleSetting Url Slug Name --- ---- ---- /api/v2/settings/all/ all All /api/v2/settings/authentication/ authentication Authentication /api/v2/settings/azuread-oauth2/ azuread-oauth2 Azure AD OAuth2 (snip) /api/v2/settings/system/ system System /api/v2/settings/tacacsplus/ tacacsplus TACACS+ /api/v2/settings/ui/ ui UI</dev:code> <dev:remarks> <maml:para>Retreive list of Settings name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleSetting -name github Key Value --- ----- SOCIAL_AUTH_GITHUB_CALLBACK_URL http://localhost:8013/sso/complete/github/ SOCIAL_AUTH_GITHUB_KEY SOCIAL_AUTH_GITHUB_SECRET SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP SOCIAL_AUTH_GITHUB_TEAM_MAP</dev:code> <dev:remarks> <maml:para>Retreive list of Settings name.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleSurveySpec</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleSurveySpec</command:noun> <maml:description> <maml:para>Retrieve Survey specifications.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Survey specifications for JobTemplate or WorkflowJobTemplate.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/job_templates/{id}/survey_spec/` - `/api/v2/workflow_job_templates/{id}/survey_spec/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleSurveySpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">JobTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJobTemplate</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.ResourceType</maml:name> </dev:type> <maml:description> <maml:para>Input by `Type` property in the pipeline object.</maml:para> <maml:para>Acceptable values: - `JobTemplate` - `WorkflowJobTemplate` </maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Input by `Id` property in the pipeline object.</maml:para> <maml:para>Database ID for the ResourceType</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Survey</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleSurveySpec -Type JobTemplate -Id 10 Name Description Spec ---- ----------- ---- {{ Name = User, Type = Text, Variable = user_name, Default = }, …}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Register-AnsibleSurveySpec</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleSurveySpec</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleSystemJob</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleSystemJob</command:noun> <maml:description> <maml:para>Retrieve SystemJob details by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve SystemJob details by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/system_job/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleSystemJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more SystemJobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more SystemJobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.SystemJob+Detail</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleSystemJob -Id 10 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 10 SystemJob Cleanup Expired Sessions cleanup_sessions Scheduled Successful 2024/07/06 22:01:18 2.494 [schedule][4]Cleanup Expired Sessions [4]Cleanup Expired Sessions {[ExtraVars, ], [Stdout, Expired Sessions deleted 16…</dev:code> <dev:remarks> <maml:para>Retrieve a SystemJob for Database ID 10.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleSystemJobTemplate</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleSystemJobTemplate</command:noun> <maml:description> <maml:para>Retrieve SystemJobTemplates by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve SystemJobTemplates by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/system_job_template/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleSystemJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more SystemJobTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more SystemJobTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.SystemJobTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleSystemJobTemplate -Id 1 Id Type Name Description Status Modified LastJobRun NextJobRun Options Note -- ---- ---- ----------- ------ -------- ---------- ---------- ------- ---- 1 SystemJobTemplate Cleanup Job Details Remove job history Successful 2023/11/04 16:19:08 2024/07/28 16:19:34 2024/08/11 16:19:08 {[JobType, cleanup_jobs]}</dev:code> <dev:remarks> <maml:para>Retrieve a SystemJobTemplate for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleTeam</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleTeam</command:noun> <maml:description> <maml:para>Retrieve Teams by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Teams by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/teams/{id}/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleTeam</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more JobTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more JobTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Team</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleTeam -Id 1 Id Type Name Description Created Modified OrganizationName -- ---- ---- ----------- ------- -------- ---------------- 1 Team TestTeam1 Sample Team 2024/06/03 18:17:55 2024/06/03 18:17:55 SampleOrg</dev:code> <dev:remarks> <maml:para>Retrieve a Team for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleToken</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleToken</command:noun> <maml:description> <maml:para>Retrieve (OAuth2) AccessTokens by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve OAuth2 Access Tokens by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/tokens/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Tokens.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Tokens.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.OAuth2AccessToken</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleToken -Id 1 Id Type Description Created Modified Expires User Username Application ApplicationName Scope -- ---- ----------- ------- -------- ------- ---- -------- ----------- --------------- ----- 1 OAuth2AccessToken Admin PersonalAccessToken 2024/05/18 15:29:33 2024/05/18 15:29:33 3023/09/19 15:29:33 1 admin write</dev:code> <dev:remarks> <maml:para>Retrieve an AccessToken for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleUser</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleUser</command:noun> <maml:description> <maml:para>Retrieve Users by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Users by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/users/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more Users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleUser -Id 1 Id Type Username Email FirstName LastName IsSuperuser IsSystemAuditor Created Modified LastLogin LdapDn ExternalAccount -- ---- -------- ----- --------- -------- ----------- --------------- ------- -------- --------- ------ --------------- 1 User admin admin@localhost True False 2023/11/04 16:20:25 2024/08/02 16:26:10 2024/08/02 16:26:10</dev:code> <dev:remarks> <maml:para>Retrieve a User for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleVariableData</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleVariableData</command:noun> <maml:description> <maml:para>Retrieve Variable Data</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve Variable Data for Inventory, Group or Host.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventories/{id}/variable_data/` - `/api/v2/groups/{id}/variable_data/` - `/api/v2/hosts/{id}/variable_data/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleVariableData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Inventory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Group</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Datebase ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.ResourceType</maml:name> </dev:type> <maml:description> <maml:para>Input by `Type` property in the pipeline object.</maml:para> <maml:para>Acceptable values: - `Inventory` - `Group` - `Host`</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Input by `Id` property in the pipeline object.</maml:para> <maml:para>Database ID for the ResourceType</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.Dictionary`2[[System.String],[System.Object]]</maml:name> </dev:type> <maml:description> <maml:para>All variables for the resource.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleVariableData -Type Group -Id 1 Key Value --- ----- ansible_connection ssh ansible_ssh_private_key_file id_ed25519_ansible ansible_user ansible</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleWorkflowApprovalRequest</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleWorkflowApprovalRequest</command:noun> <maml:description> <maml:para>Retrieve request jobs for WorkflowApproval by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve JobTemplates by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_approvals/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleWorkflowApprovalRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more WorkflowApproval.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more WorkflowApproval.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowApproval+Detail</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleWorkflowApprovalRequest -Id 10 Id Type Name Status TimedOut Expire Remaining By Finished Elapsed LaunchedBy WorkflowJob WorkflowJobTemplate ApprovalTemplate -- ---- ---- ------ -------- ------ --------- -- -------- ------- ---------- ----------- ------------------- ---------------- 10 WorkflowApproval Sample-Approval Failed False [1]admin 2024/07/25 15:46:16 54.573 [user][1]admin [20]ApprovedFlow [13]ApprovedFlow [12]Sample-Approval</dev:code> <dev:remarks> <maml:para>Retrieve a WorkflowApproval for Database ID 10.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Approve-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Deny-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleWorkflowApprovalTemplate</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleWorkflowApprovalTemplate</command:noun> <maml:description> <maml:para>Retrieve WorkflowApprovalTemplates by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve WorkflowApprovalTemplates by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_approval_templates/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleWorkflowApprovalTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more WorkflowApprovalTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more WorkflowApprovalTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowApprovalTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To get the ID number of the WorkflowApprovalTemplate, see `Template ID` column in the nodes from `Find-AnsibleWorkflowJobTemplateNode` command or `ApprovalTemplate` column in the jobs from `Find-AnsibleWorkflowApprovalRequest` command.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleWorkflowApprovalTemplate -Id 12 Id Type Name Description Status Modified LastJobRun NextJobRun Options Note -- ---- ---- ----------- ------ -------- ---------- ---------- ------- ---- 12 WorkflowApprovalTemplate Sample-Approval Before Launch Failed 2024/07/25 14:44:57 2024/07/25 15:46:16 {[Timeout, 0], [WorkflowTemplate, [20]ApprovedFlow]}</dev:code> <dev:remarks> <maml:para>Retrieve a JobTemplate for Database ID 12.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleWorkflowJob</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleWorkflowJob</command:noun> <maml:description> <maml:para>Retrieve WorkflowJob details by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve WorkflowJob details by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_jobs/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleWorkflowJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJob+Detail</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleWorkflowJob -Id 20 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 20 WorkflowJob TestWorkflow Manual Successful 2024/07/22 12:53:23 4.276 [user][1]admin [13]TestWorkflow {[Labels, test], [Inventory, [2]], [Limit, ], [Branch, ]…}</dev:code> <dev:remarks> <maml:para>Retrieve a WorkflowJob detail for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleWorkflowJobNode</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleWorkflowJobNode</command:noun> <maml:description> <maml:para>Retrieve nodes for WorkflowJob by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve nodes for WorkflowJob by specified ID(s).</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_nodes/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleWorkflowJobNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more nodes in WorkflowJob.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more nodes in WorkflowJob.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobNode</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleWorkflowJobNode -Id 10 Id Type WorkflowJob DoNotRun Modified Job JobType JobName JobStatus JobElapsed SuccessNodes FailureNodes AlwaysNodes -- ---- ----------- -------- -------- --- ------- ------- --------- ---------- ------------ ------------ ----------- 10 WorkflowJobNode [151]TestWorkflow False 2024/07/11 9:27:45 152 Job Test_1 Successful 2.033 {} {} {11}</dev:code> <dev:remarks> <maml:para>Retrieve a node in WorkflowJob for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleWorkflowJobTemplate</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleWorkflowJobTemplate</command:noun> <maml:description> <maml:para>Retrieve WorkflowJobTemplates by the ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve WorkflowJobTemplates by the specified ID(s).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_job_templates/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more JobTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more JobTemplates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleWorkflowJobTemplate -Id 13 Id Type Name Description Status Modified LastJobRun NextJobRun Options Note -- ---- ---- ----------- ------ -------- ---------- ---------- ------- ---- 13 WorkflowJobTemplate TestWorkflow Sample Workflow Successful 2024/07/10 18:45:06 2024/07/22 12:53:23 2024/06/12 17:45:00 None {[Organization, [2]TestOrg], [Inventory, [2]TestInventory], [Branch, ], [Limit, ]…}</dev:code> <dev:remarks> <maml:para>Retrieve a WorkflowJobTemplate for Database ID 13.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AnsibleWorkflowJobTemplateNode</command:name> <command:verb>Get</command:verb> <command:noun>AnsibleWorkflowJobTemplateNode</command:noun> <maml:description> <maml:para>Retrieve nodes for WorkflowJobTemplate by ID(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve nodes for WorkflowJobTemplate by specified ID(s).</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_template_nodes/{id}/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more nodes in WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>List of database IDs for one or more nodes in WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64[]</maml:name> </dev:type> <maml:description> <maml:para>One or more database IDs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplateNode</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleWorkflowJobTemplateNode -Id 1 Id Type WorkflowJobTemplate Template ID Template Type Template Name SuccessNodes FailureNodes AlwaysNodes -- ---- ------------------- ----------- ------------- ------------- ------------ ------------ ----------- 1 WorkflowJobTemplateNode [13]TestWorkflow 9 Job Test_1 {} {} {4}</dev:code> <dev:remarks> <maml:para>Retrieve a node in WorkflowJob for Database ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Grant-AnsibleRole</command:name> <command:verb>Grant</command:verb> <command:noun>AnsibleRole</command:noun> <maml:description> <maml:para>Grant Roles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Grant Roles to a User or Team.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/users/{id}/roles/` (POST) - `/api/v2/teams/{id}/roles/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Grant-AnsibleRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Target role objects to be granted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource[]</command:parameterValue> <dev:type> <maml:name>IResource[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>Target resource (`User` or `Team`) to be granted to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Target role objects to be granted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource[]</command:parameterValue> <dev:type> <maml:name>IResource[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>Target resource (`User` or `Team`) to be granted to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource[]</maml:name> </dev:type> <maml:description> <maml:para>Role objects to be granted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $roles = Find-AnsibleObjectRole -Type JobTemplate -Id 10 PS C:\> $user = Get-AnsibleUser -Id 2 PS C:\> Grant-AnsibleRole -Roles $roles -To $user</dev:code> <dev:remarks> <maml:para>Grant all roles of JobTemplate ID 10 to the Uesr of ID 2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleObjectRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Revoke-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-AnsibleAdHocCommand</command:name> <command:verb>Invoke</command:verb> <command:noun>AnsibleAdHocCommand</command:noun> <maml:description> <maml:para>Invoke (launch) an AdHocCommand and wait until the job is finished.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Launch an AdHocCommand and wait until the job is finished.</maml:para> <maml:para>Implementation of following API: - `/api/v2/inventories/{id}/ad_hoc_commands/` - `/api/v2/groups/{id}/ad_hoc_commands/` - `/api/v2/hosts/{id}/ad_hoc_commands/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleAdHocCommand ... -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [30] ping ====== > > localhost | SUCCESS => { > "changed": false, > "ping": "pong" > }</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Group</command:parameterValue> <dev:type> <maml:name>Group</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleAdHocCommand ... -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [30] ping ====== > > localhost | SUCCESS => { > "changed": false, > "ping": "pong" > }</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Host</maml:name> <maml:description> <maml:para>Host to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Host</command:parameterValue> <dev:type> <maml:name>Host</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleAdHocCommand ... -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [30] ping ====== > > localhost | SUCCESS => { > "changed": false, > "ping": "pong" > }</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Inventory</command:parameterValue> <dev:type> <maml:name>Inventory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleAdHocCommand ... -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [30] ping ====== > > localhost | SUCCESS => { > "changed": false, > "ping": "pong" > }</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InventoryId</maml:name> <maml:description> <maml:para>Inventory ID to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleAdHocCommand ... -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [30] ping ====== > > localhost | SUCCESS => { > "changed": false, > "ping": "pong" > }</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Group</command:parameterValue> <dev:type> <maml:name>Group</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Host</maml:name> <maml:description> <maml:para>Host to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Host</command:parameterValue> <dev:type> <maml:name>Host</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Inventory</command:parameterValue> <dev:type> <maml:name>Inventory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InventoryId</maml:name> <maml:description> <maml:para>Inventory ID to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleAdHocCommand ... -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [30] ping ====== > > localhost | SUCCESS => { > "changed": false, > "ping": "pong" > }</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Host</maml:name> </dev:type> <maml:description> <maml:para>Host object to be executed.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Group</maml:name> </dev:type> <maml:description> <maml:para>Group object to be executed.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Inventory</maml:name> </dev:type> <maml:description> <maml:para>Inventory object to be executed.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Inventory ID to be executed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.AdHocCommand</maml:name> </dev:type> <maml:description> <maml:para>AdHocCommand job object (non-completed status)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleGroup -Id 1 | Invoke-AnsibleAdHocCommand -ModuleName ping -Credential 1 ====== [20] ping ====== localhost | SUCCESS => { "changed": false, "ping": "pong" } hostA | UNREACHABLE! => { "changed": false, "msg": "Failed to connect to the host via ssh: ssh: connect to host ***.***.***.*** port 22: Connection timed out", "unreachable": true } Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 20 AdHocCommand ping run Manual Failed 2024/08/06 12:14:35 11.651 [user][1]admin ping {[ModuleArgs, ], [Limit, TestGroup], [Inventory, [2]TestInventory]}</dev:code> <dev:remarks> <maml:para>Launch `ping` ansible module to the Group ID 1, and wait until for the job is finished.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-AnsibleAPI</command:name> <command:verb>Invoke</command:verb> <command:noun>AnsibleAPI</command:noun> <maml:description> <maml:para>Execute Ansible's (low-level) Rest API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Make GET, POST, PUT, PATCH, DELETE or OPTIONS request to specified Path, and get the response.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-AnsibleAPI</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>HTTP method to make request.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GET</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">POST</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PUT</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PATCH</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DELETE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OPTIONS</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Method</command:parameterValue> <dev:type> <maml:name>Method</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>URL path to make request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>QueryString</maml:name> <maml:description> <maml:para>URL query to make request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsRawString</maml:name> <maml:description> <maml:para>Returns response data as raw string instead of deserializing to object.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleAPI</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>HTTP method to make request.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">GET</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">POST</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PUT</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PATCH</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DELETE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OPTIONS</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Method</command:parameterValue> <dev:type> <maml:name>Method</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>URL path to make request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>QueryString</maml:name> <maml:description> <maml:para>URL query to make request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsRawString</maml:name> <maml:description> <maml:para>Returns response data as raw string instead of deserializing to object.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SenData</maml:name> <maml:description> <maml:para>Data to be sent to the API. When value is not String, it will be deserialized to JSON string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsRawString</maml:name> <maml:description> <maml:para>Returns response data as raw string instead of deserializing to object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>HTTP method to make request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Method</command:parameterValue> <dev:type> <maml:name>Method</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>URL path to make request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>QueryString</maml:name> <maml:description> <maml:para>URL query to make request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SenData</maml:name> <maml:description> <maml:para>Data to be sent to the API. When value is not String, it will be deserialized to JSON string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Data to be sent to the API. When value is not String, it will be deserialized to JSON string.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-AnsibleAPI GET /api/v2/ping/ -AsRawString {"ha":false,"version":"23.3.1","active_node":"awx_1", ... }</dev:code> <dev:remarks> <maml:para>Make `GET` request to `/api/v2/ping/` and get response as String</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Invoke-AnsibleAPI PATCH /api/v2/users/2/ -SenData @{ last_name = "mako" } Id Type Username Email FirstName LastName IsSuperuser IsSystemAuditor Created Modified LastLogin LdapDn ExternalAccount -- ---- -------- ----- --------- -------- ----------- --------------- ------- -------- --------- ------ --------------- 2 User teramako teramako@gmail.com tera mako False False 2024/05/21 0:13:43 2024/06/10 22:48:18 2024/06/10 22:48:18</dev:code> <dev:remarks> <maml:para>Make `PATCH` request to `/api/v2/users/2/` for change `last_name` field.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleApiHelp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-AnsibleInventoryUpdate</command:name> <command:verb>Invoke</command:verb> <command:noun>AnsibleInventoryUpdate</command:noun> <maml:description> <maml:para>Invoke (update) an InventorySource and wait until the job is finished.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update InventorySources and wait until the job is finished. Multiple InventorySources in the Inventory may be udpated, when an Inventory is specified bye `-Inventory` parameter.</maml:para> <maml:para>Implementation of following API: - `/api/v2/inventory_sources/{id}/update/` - `/api/v2/inventries/{id}/update_inventory_sources/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-AnsibleInventoryUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter InventorySource(s) can be updated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleInventoryUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>A `Inventory` or `InventorySource` object.</maml:para> <maml:para>If the value is `Inventory`, all of InventorySources in the Inventory will be updated or checked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter InventorySource(s) can be updated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleInventoryUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleInventoryUpdate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] TestInventory - test_source ====== > > (snip)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleInventoryUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>A `Inventory` or `InventorySource` object.</maml:para> <maml:para>If the value is `Inventory`, all of InventorySources in the Inventory will be updated or checked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleInventoryUpdate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] TestInventory - test_source ====== > > (snip)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter InventorySource(s) can be updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>A `Inventory` or `InventorySource` object.</maml:para> <maml:para>If the value is `Inventory`, all of InventorySources in the Inventory will be updated or checked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleInventoryUpdate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] TestInventory - test_source ====== > > (snip)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>InventorySource ID</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.InventorySource</maml:name> </dev:type> <maml:description> <maml:para>InventorySource object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Inventory</maml:name> </dev:type> <maml:description> <maml:para>Inventory object containing the InventorySources to be updated.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InventoryUpdateJob</maml:name> </dev:type> <maml:description> <maml:para>The result job object of updated the InventorySource.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>Results of checked wheter the InventorySources can be updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-AnsibleInventoryUpdate -Id 11 ====== [100] TestInventory - test_source ====== ansible-inventory [core 2.15.12] config file = /runner/project/ansible.cfg (snip) Parsed /runner/project/inventory/hosts.ini inventory source with ini plugin 2.718 INFO Processing JSON output... 2.718 INFO Loaded 1 groups, 2 hosts 2.719 WARNING loading into database... 2.727 WARNING group updates took 2 queries for 1 groups 2.731 WARNING host updates took 2 queries for 2 hosts 2.731 WARNING Group-group updates took 0 queries for 0 group-group relationships 2.737 WARNING Group-host updates took 3 queries for 1 group-host relationships 2.745 WARNING update computed fields took 8 queries 2.746 WARNING Inventory import completed for test_source in 0.0s 2.746 WARNING Inventory import required 26 queries taking 0.005s Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 100 InventoryUpdate TestInventory - test_source Manual Successful 2024/08/06 14:51:07 2.751 [user][1]admin [11]test_source {[Inventory, [2]TestInventory], [Source, Scm], [SourcePath, inventory/hosts.ini]}</dev:code> <dev:remarks> <maml:para>Update an InventorySource ID 11, and wait until for the job is finished.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleInventory -Id 2 | Invoke-AnsibleInventoryUpdate -Check Id Type CanUpdate -- ---- --------- 11 InventorySource True 17 InventorySource True</dev:code> <dev:remarks> <maml:para>Check wheter InventorySources in the Inventory ID 2 can be updated.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AnsibleInventoryUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-AnsibleJobTemplate</command:name> <command:verb>Invoke</command:verb> <command:noun>AnsibleJobTemplate</command:noun> <maml:description> <maml:para>Invoke (launch) a JobTemplate and wait unti the job is finished.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Launch the specified JobTemplate and wait until the job is finished.</maml:para> <maml:para>Implementation of following API: - `/api/v2/job_templates/{id}/launch/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-AnsibleJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Specify credential IDs.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Specify diff mode.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>Specify ExecutionEnvironment ID.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Specify the number of forks.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Specify the number of job slice count.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] Demo Job Template ====== > > PLAY [Hello World Sample] * * * * * * * * * * * * > > (snip) > > PLAY RECAP * * * * * * * * * * * * * * * > localhost : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specify timeout value (seconds).</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Specify job verbosity.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Specify credential IDs.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Specify diff mode.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>Specify ExecutionEnvironment ID.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Specify the number of forks.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Specify the number of job slice count.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] Demo Job Template ====== > > PLAY [Hello World Sample] * * * * * * * * * * * * > > (snip) > > PLAY RECAP * * * * * * * * * * * * * * * > localhost : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specify timeout value (seconds).</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Specify job verbosity.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>JobTemplate</maml:name> <maml:description> <maml:para>JobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Specify credential IDs.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Specify diff mode.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>Specify ExecutionEnvironment ID.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Specify the number of forks.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Specify the number of job slice count.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] Demo Job Template ====== > > PLAY [Hello World Sample] * * * * * * * * * * * * > > (snip) > > PLAY RECAP * * * * * * * * * * * * * * * > localhost : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specify timeout value (seconds).</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Specify job verbosity.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Specify credential IDs.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Specify diff mode.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>Specify ExecutionEnvironment ID.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Specify the number of forks.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Specify the number of job slice count.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>JobTemplate</maml:name> <maml:description> <maml:para>JobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] Demo Job Template ====== > > PLAY [Hello World Sample] * * * * * * * * * * * * > > (snip) > > PLAY RECAP * * * * * * * * * * * * * * * > localhost : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specify timeout value (seconds).</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Specify job verbosity.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>JobTemplate ID to be launched.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.JobTemplate</maml:name> </dev:type> <maml:description> <maml:para>JobTemplate object to be launched.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobTemplateJob</maml:name> </dev:type> <maml:description> <maml:para>The result job object of lanched the JobTemplate.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> > Invoke-AnsibleJobtemplate -Id 7 [7] Demo Job Template - Inventory : [1] Demo Inventory Extra vars : --- Diff Mode : False Job Type : Run Verbosity : 0 (Normal) Credentials : [1] Demo Credential Forks : 0 Job Slice Count : 1 Timeout : 0 ====== [100] Demo Job Template ====== PLAY [Hello World Sample] ****************************************************** TASK [Gathering Facts] ********************************************************* ok: [localhost] TASK [Hello Message] *********************************************************** ok: [localhost] => { "msg": "Hello World!" } PLAY RECAP ********************************************************************* localhost : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 100 Job Demo Job Template Run Manual Successful 2024/08/06 15:19:01 1.983 [user][1]admin [7]Demo Job Template {[Playbook, hello_world.yml], [Artifacts, {}], [Labels, ]}</dev:code> <dev:remarks> <maml:para>Launch JobTemplate ID 7, and wait unti for the job is finished.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-AnsibleProjectUpdate</command:name> <command:verb>Invoke</command:verb> <command:noun>AnsibleProjectUpdate</command:noun> <maml:description> <maml:para>Invoke (update) a Project and wait until the job is finished.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Project and wait until the job is finished.</maml:para> <maml:para>Implementation of following API: - `/api/v2/projects/{id}/update/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-AnsibleProjectUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter a Project can be updated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleProjectUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project object to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter a Project can be updated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleProjectUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleProjectUpdate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] proj_1 ====== > > (snip) > > PLAY RECAP * * * * * * * * * * * * * * * > localhost : ok=3 changed=0 unreachable=0 failed=0 skipped=4 rescued=0 ignored=0</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleProjectUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project object to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleProjectUpdate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] proj_1 ====== > > (snip) > > PLAY RECAP * * * * * * * * * * * * * * * > localhost : ok=3 changed=0 unreachable=0 failed=0 skipped=4 rescued=0 ignored=0</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter a Project can be updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project object to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleProjectUpdate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [100] proj_1 ====== > > (snip) > > PLAY RECAP * * * * * * * * * * * * * * * > localhost : ok=3 changed=0 unreachable=0 failed=0 skipped=4 rescued=0 ignored=0</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Project</maml:name> </dev:type> <maml:description> <maml:para>Project object to be updated.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ProjectUpdateJob</maml:name> </dev:type> <maml:description> <maml:para>The result job object of updated the Project.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>Results of checked wheter the Project can be updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-AnsibleProjectUpdate -Id 8 ====== [100] proj_1 ====== Identity added: /runner/artifacts/336/ssh_key_data (***@********) PLAY [Update source tree if necessary] ***************************************** (snip) PLAY RECAP ********************************************************************* localhost : ok=3 changed=0 unreachable=0 failed=0 skipped=4 rescued=0 ignored=0 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 100 ProjectUpdate proj_1 Check Manual Successful 2024/08/06 15:34:34 1.888 [user][1]admin [8][git]proj_1 {[Branch, master], [Revision, 3cc7efff0ab80a0108456317c47214509728c9d3], [Url, git@gitrepo:repo1.git]}</dev:code> <dev:remarks> <maml:para>Update a Project ID 8, and wait until for the job is finished.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Invoke-AnsibleProjectUpdate -Id 8 -Check Id Type CanUpdate -- ---- --------- 8 Project True</dev:code> <dev:remarks> <maml:para>Check wheter Project ID 8 can be updated.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AnsibleProjectUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleProjectUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProjectUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-AnsibleSystemJobTemplate</command:name> <command:verb>Invoke</command:verb> <command:noun>AnsibleSystemJobTemplate</command:noun> <maml:description> <maml:para>Invoke (launch) a SystemJobTemplate and wait unti the job is finished.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Launch the specified SystemJobTemplate and wait until the job is finished.</maml:para> <maml:para>Implementation of following API: - `/api/v2/system_job_templates/{id}/launch/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-AnsibleSystemJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Variables to be passed to the system job task as command line parameters.</maml:para> <maml:para>For excample: - `@{ dry_run: $true }` : for `cleanup_jobs` and `cleanup_activitystream` - `@{ days: 90 }'` : for `cleanup_jobs` and `cleanup_activitystream`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleSystemJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ==> [463] SystemJob > (snip) </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleSystemJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>SystemJobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Variables to be passed to the system job task as command line parameters.</maml:para> <maml:para>For excample: - `@{ dry_run: $true }` : for `cleanup_jobs` and `cleanup_activitystream` - `@{ days: 90 }'` : for `cleanup_jobs` and `cleanup_activitystream`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleSystemJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ==> [463] SystemJob > (snip) </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleSystemJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SystemJobTemplate</maml:name> <maml:description> <maml:para>SystemJobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Variables to be passed to the system job task as command line parameters.</maml:para> <maml:para>For excample: - `@{ dry_run: $true }` : for `cleanup_jobs` and `cleanup_activitystream` - `@{ days: 90 }'` : for `cleanup_jobs` and `cleanup_activitystream`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleSystemJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ==> [463] SystemJob > (snip) </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Variables to be passed to the system job task as command line parameters.</maml:para> <maml:para>For excample: - `@{ dry_run: $true }` : for `cleanup_jobs` and `cleanup_activitystream` - `@{ days: 90 }'` : for `cleanup_jobs` and `cleanup_activitystream`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>SystemJobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleSystemJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ==> [463] SystemJob > (snip) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SystemJobTemplate</maml:name> <maml:description> <maml:para>SystemJobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>SystemJobTemplate ID to be launched.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.SystemJobTemplate</maml:name> </dev:type> <maml:description> <maml:para>SystemJobTemplate object to be launched.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.SystemJob</maml:name> </dev:type> <maml:description> <maml:para>The result job object of lanched the SystemJobTemplate.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-AnsibleSystemJobTemplate -Id 4 ====== [110] Cleanup Expired Sessions ====== Expired Sessions deleted 2 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 110 SystemJob Cleanup Expired Sessions cleanup_sessions Manual Successful 2024/08/06 15:56:27 1.793 [user][1]admin [4]Cleanup Expired Sessions {[ExtraVars, {}], [Stdout, Expired Sessions deleted 2…</dev:code> <dev:remarks> <maml:para>Launch JobTemplate ID 4, and wait unti for the job is finished.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Invoke-AnsibleSystemJobTemplate -Id 2 -ExtraVars @{ dry_run = $true } ====== [120] Cleanup Activity Stream ====== would skip "update-2024-05-18T06:21:07.998340+00:00-pk=23" id: 23 would skip "create-2024-05-18T06:29:33.680642+00:00-pk=24" id: 24 (snip) Removed 0 items Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 120 SystemJob Cleanup Activity Stream cleanup_activitystream Manual Successful 2024/08/06 16:04:30 2.171 [user][1]admin [2]Cleanup Activity Stream {[ExtraVars, {"dry_run": true}], *** }</dev:code> <dev:remarks> <maml:para>Launch SystemJobTemplate ID 2(Cleanup ActivityStream) as dry-run mode.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-AnsibleWorkflowJobTemplate</command:name> <command:verb>Invoke</command:verb> <command:noun>AnsibleWorkflowJobTemplate</command:noun> <maml:description> <maml:para>Invoke (update) a WorkflowJobTemplate and wait until the job is finished.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Launch a WorkflowJobTemplate and wait until the job is finished.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_templates/{id}/launch/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleWorkflowJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [111] Test_1 ====== > > (snip) > > ====== [112] Demo Job Template ====== > > (snip)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleWorkflowJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [111] Test_1 ====== > > (snip) > > ====== [112] Demo Job Template ====== > > (snip)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowJobTemplate</maml:name> <maml:description> <maml:para>WorkflowJobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleWorkflowJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [111] Test_1 ====== > > (snip) > > ====== [112] Demo Job Template ====== > > (snip)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Invoke-AnsibleWorkflowJobTemplate ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [111] Test_1 ====== > > (snip) > > ====== [112] Demo Job Template ====== > > (snip)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowJobTemplate</maml:name> <maml:description> <maml:para>WorkflowJobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplate ID to be launched.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplate</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplate object to be launched.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJob</maml:name> </dev:type> <maml:description> <maml:para>The result job object of lanched the WorkflowJobTemplate.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-AnsibleWorkflowJobTemplate -Id 13 [13] TestWorkflow - Workflow Demo Inventory : [2] TestInventory Labels : [1] test Extra vars : --- ====== [111] Test_1 ====== (snip) ====== [112] Demo Job Template ====== (snip) Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 110 WorkflowJob TestWorkflow Manual Successful 2024/08/06 16:21:10 4.202 [user][1]admin [13]TestWorkflow {[Labels, test], [Inventory, [2]], [Limit, ], [Branch, ]…}</dev:code> <dev:remarks> <maml:para>Launch WorkflowJobTemplate ID 13, and wait unti for the job is finished.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleApiConfig</command:name> <command:verb>New</command:verb> <command:noun>AnsibleApiConfig</command:noun> <maml:description> <maml:para>Create config file that should be used by this module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a configuration file which is stored AWX/AnsibleTower URL, OAuth2 AccessToken and etc... This will be the first thing you should do when using this module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleApiConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>AWX/AnsibleTower URL</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Lang</maml:name> <maml:description> <maml:para>Language information. Set in the HTTP request header (`Accept-Language`) primary, part of the API response will be localized.</maml:para> <maml:para>For example:</maml:para> <maml:para>- `-Lang ja-JP`</maml:para> <maml:para>- `-Lang $Host.CurrentCulture`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CultureInfo</command:parameterValue> <dev:type> <maml:name>CultureInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>Configuration file path</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Lang</maml:name> <maml:description> <maml:para>Language information. Set in the HTTP request header (`Accept-Language`) primary, part of the API response will be localized.</maml:para> <maml:para>For example:</maml:para> <maml:para>- `-Lang ja-JP`</maml:para> <maml:para>- `-Lang $Host.CurrentCulture`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CultureInfo</command:parameterValue> <dev:type> <maml:name>CultureInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>Configuration file path</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>AWX/AnsibleTower URL</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.ApiConfig</maml:name> </dev:type> <maml:description> <maml:para>Newly created configuration object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleApiConfig -Uri http://localhost:8013/ _ _ _ | | __ _ __ _ __ _| |__ __ _| |_ __ _ _ __ ___ _ __ ___ _ | |/ _` |/ _` |/ _` | '_ \ / _` | __/ _` | | '_ \/ __| '_ ` _ \ | |_| | (_| | (_| | (_| | |_) | (_| | || (_| |_| |_) \__ \ | | | | | \___/ \__,_|\__, |\__,_|_.__/ \__,_|\__\__,_(_) .__/|___/_| |_| |_| |___/ |_| Please enter the your Personal Access Token(PAT) Personal Token: ****************************** Try to retrieve the user information from: http://localhost:8013/ Success: ******(*****@*****.***) Save config to: C:\Users\*****\.ansible_api_config.json Sccess 🎉 Origin LastSaved File ------ --------- ---- http://localhost:8013/ 2024/08/06 7:42:02 C:\Users\*****\.ansible_api_config.json</dev:code> <dev:remarks> <maml:para>Create new configuration file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleApiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Switch-AnsibleApiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleApplication</command:name> <command:verb>New</command:verb> <command:noun>AnsibleApplication</command:noun> <maml:description> <maml:para>Create an Application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create an Application.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/applications/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AuthorizationGrantType</maml:name> <maml:description> <maml:para>The Grant type the user must use for acquire tokens for the Application.</maml:para> <maml:para>- `authorization-code`: Authorization Code - `password`: Resource owner password-based</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">password</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">authorization-code</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>Set to `Public` or `Confidential` depending on how secure the client device is.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Confidential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ApplicationClientType</command:parameterValue> <dev:type> <maml:name>ApplicationClientType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RedirectUris</maml:name> <maml:description> <maml:para>Allowed URIs list, space separated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipAuthorization</maml:name> <maml:description> <maml:para>Set to skip authorization step for completely trusted application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AuthorizationGrantType</maml:name> <maml:description> <maml:para>The Grant type the user must use for acquire tokens for the Application.</maml:para> <maml:para>- `authorization-code`: Authorization Code - `password`: Resource owner password-based</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>Set to `Public` or `Confidential` depending on how secure the client device is.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApplicationClientType</command:parameterValue> <dev:type> <maml:name>ApplicationClientType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RedirectUris</maml:name> <maml:description> <maml:para>Allowed URIs list, space separated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipAuthorization</maml:name> <maml:description> <maml:para>Set to skip authorization step for completely trusted application.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Application</maml:name> </dev:type> <maml:description> <maml:para>New created Application object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleApplication -Name AppName -Organization 1 -AuthorizationGrantType authorization-code -ClientType Confidential</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleCredential</command:name> <command:verb>New</command:verb> <command:noun>AnsibleCredential</command:noun> <maml:description> <maml:para>Create a Credential.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a Credential.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/credentials/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>CredentialType ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Grant role of the specified resource as owner. If ommited, used User ID of the current config.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>CredentialType ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Grant role of the specified resource as owner. If ommited, used User ID of the current config.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Credential</maml:name> </dev:type> <maml:description> <maml:para>New created Credential object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $inputs = @{ username = "foo_user"; password = "P@ssw0rd" } PS C:\> New-AnsibleCredential -CredentialType 1 -Name Foo-Cred -Input $inputs -Owner (Get-AnsibleOrganization -Id 2)</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleCredentialType</command:name> <command:verb>New</command:verb> <command:noun>AnsibleCredentialType</command:noun> <maml:description> <maml:para>Create a CredentialType.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a CredentialType.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/credential_types/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleCredentialType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">net</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cloud</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Injectors</maml:name> <maml:description> <maml:para>Custom Credential Type Injectors object which raw Dictionary or `Jagabata.CredentialType.Injectors`.</maml:para> <maml:para>See: https://github.com/teramako/Jagabata.psm/blob/develop/docs/en-US/CredentialType.md</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para>Custom Credential Type Inputs object which raw Dictionary or `Jagabata.CredentialType.FieldList`.</maml:para> <maml:para>See: https://github.com/teramako/Jagabata.psm/blob/develop/docs/en-US/CredentialType.md</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Injectors</maml:name> <maml:description> <maml:para>Custom Credential Type Injectors object which raw Dictionary or `Jagabata.CredentialType.Injectors`.</maml:para> <maml:para>See: https://github.com/teramako/Jagabata.psm/blob/develop/docs/en-US/CredentialType.md</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para>Custom Credential Type Inputs object which raw Dictionary or `Jagabata.CredentialType.FieldList`.</maml:para> <maml:para>See: https://github.com/teramako/Jagabata.psm/blob/develop/docs/en-US/CredentialType.md</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.CredentialType</maml:name> </dev:type> <maml:description> <maml:para>New created CredentialType object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $inputs = @{ fields = @( @{ id="pass"; label="Password"; secret = $true } ); required = @("pass") } PS C:\> $injectors = @{ env = @{ FOO_PASSWORD = "{{pass}}" } } PS C:\> New-AnsibleCredentialType -Name demoCredType -Kind net -Inputs $inputs -Injectors $injectors</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleExecutionEnvironment</command:name> <command:verb>New</command:verb> <command:noun>AnsibleExecutionEnvironment</command:noun> <maml:description> <maml:para>Create an ExecutionEnvironment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Credential an ExecutionEnvironment.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/execution_environments/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleExecutionEnvironment</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID for container registry (kind = `registry`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Image</maml:name> <maml:description> <maml:para>The full image location, including the container registry, image name, and version tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID used to determine access to the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Pull</maml:name> <maml:description> <maml:para>Pull image before running: - ``: (defualt) - `always`: Always pull container before running. - `missing`: Only pull the image if not present before running. - `never`: Never pull container before running.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false"></command:parameterValue> <command:parameterValue required="false" command:variableLength="false">always</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">missing</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">never</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID for container registry (kind = `registry`).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Image</maml:name> <maml:description> <maml:para>The full image location, including the container registry, image name, and version tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID used to determine access to the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Pull</maml:name> <maml:description> <maml:para>Pull image before running: - ``: (defualt) - `always`: Always pull container before running. - `missing`: Only pull the image if not present before running. - `never`: Never pull container before running.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ExecutionEnvironment</maml:name> </dev:type> <maml:description> <maml:para>New created ExecutionEnvironment object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleExecutionEnvironment -Name "AWX-EE 2" -Image quary.io/ansible/awx-ee:latest</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleGroup</command:name> <command:verb>New</command:verb> <command:noun>AnsibleGroup</command:noun> <maml:description> <maml:para>Create a Group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a Group.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/groups/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ ansible_connection = "ssh"; ansible_user = "ssh_user" }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ ansible_connection = "ssh"; ansible_user = "ssh_user" }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Group</maml:name> </dev:type> <maml:description> <maml:para>New created Group object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleGroup -Inventory 1 -Name group_name</dev:code> <dev:remarks> <maml:para>Create a new Group into the Inventory of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-Group</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleHost</command:name> <command:verb>New</command:verb> <command:noun>AnsibleHost</command:noun> <maml:description> <maml:para>Create a Host.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a Host.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/hosts/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Create a Host as disabled state.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>Used by the remote inventory source to uniquely identify the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ ansible_host = "192.168.0.10"; ansible_connection = "ssh"; }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Create a Host as disabled state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>Used by the remote inventory source to uniquely identify the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ ansible_host = "192.168.0.10"; ansible_connection = "ssh"; }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Host</maml:name> </dev:type> <maml:description> <maml:para>New created Host object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleHost -Inventory 1 -Name host_name</dev:code> <dev:remarks> <maml:para>Create a new Host into the Inventory of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleInventory</command:name> <command:verb>New</command:verb> <command:noun>AnsibleInventory</command:noun> <maml:description> <maml:para>Create an Inventory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create an Inventory.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventories/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsSmartInventory</maml:name> <maml:description> <maml:para>Create as Smart Inventory</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostFilter</maml:name> <maml:description> <maml:para>Filter that will be applied to the hosts of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventInstanceGroupFallback</maml:name> <maml:description> <maml:para>If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on. If this setting is enabled and you provided an empty list, the global instance groups will be applied.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ key1 = "value 1"; key2 = 10; }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventInstanceGroupFallback</maml:name> <maml:description> <maml:para>If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on. If this setting is enabled and you provided an empty list, the global instance groups will be applied.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ key1 = "value 1"; key2 = 10; }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsSmartInventory</maml:name> <maml:description> <maml:para>Create as Smart Inventory</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostFilter</maml:name> <maml:description> <maml:para>Filter that will be applied to the hosts of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventInstanceGroupFallback</maml:name> <maml:description> <maml:para>If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on. If this setting is enabled and you provided an empty list, the global instance groups will be applied.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ key1 = "value 1"; key2 = 10; }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Inventory</maml:name> </dev:type> <maml:description> <maml:para>New created Inventory object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleInventory -Organization 1 -Name test_inventory</dev:code> <dev:remarks> <maml:para>Create a new Inventory into the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleInventorySource</command:name> <command:verb>New</command:verb> <command:noun>AnsibleInventorySource</command:noun> <maml:description> <maml:para>Create an InventorySource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create an InventorySource.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventory_sources/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleInventorySource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Cloud credential ID to use for inventory updates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledValue</maml:name> <maml:description> <maml:para>Only used when enabled_var is set. Value when the host is considered enabled. For example if `enabled_var="status.power_state" and enabled_value="powered_on"` with host variables: `{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}` The host would be marked enabled. If `power_state` where any value other than `powered_on` then the host would be disabled when imported. If the key is not found then the host will be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledVar</maml:name> <maml:description> <maml:para>Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: `from_dict.get("foo", {}).get("bar", default)`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironemnt ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostFilter</maml:name> <maml:description> <maml:para>This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Enter host, group or pattern match.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite local groups and hosts from remote InventorySource.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OverwriteVars</maml:name> <maml:description> <maml:para>Overwrite local variables from remote InventorySource.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>InventorySource SCM branch. Project default used if blank. Only allowed if project `allow_override` field is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Source Type:</maml:para> <maml:para>- `File`: File, Directory or Script - `Constructed`: Template additional groups and hostvars at runtime - `Scm`: Sourced from a Project - `EC2`: Amazon EC2 - `GCE`: Google Compute Engine - `AzureRM`: Microsoft Azure Resource Manager - `VMware`: VMware vCenter - `Satellite6`: Red Hat Satellite 6 - `OpenStack`: OpenStack - `RHV`: Red Hat Virtualization - `Controller`: Red Hat Ansible Automation Platform - `Insights`: Red Hat Insights</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Constructed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scm</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EC2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GCE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureRM</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VMware</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Satellite6</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OpenStack</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RHV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Controller</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Insights</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InventorySourceSource</command:parameterValue> <dev:type> <maml:name>InventorySourceSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourcePath</maml:name> <maml:description> <maml:para>Inventory directory, file, or script to load.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceProject</maml:name> <maml:description> <maml:para>Project containing inventory file used as source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceVars</maml:name> <maml:description> <maml:para>InventorySource variables in YAML or JSON format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateCacheTimeout</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateOnLaunch</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>- `0`: Warning - `1`: Info (Default) - `2`: Debug</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Cloud credential ID to use for inventory updates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledValue</maml:name> <maml:description> <maml:para>Only used when enabled_var is set. Value when the host is considered enabled. For example if `enabled_var="status.power_state" and enabled_value="powered_on"` with host variables: `{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}` The host would be marked enabled. If `power_state` where any value other than `powered_on` then the host would be disabled when imported. If the key is not found then the host will be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledVar</maml:name> <maml:description> <maml:para>Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: `from_dict.get("foo", {}).get("bar", default)`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironemnt ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostFilter</maml:name> <maml:description> <maml:para>This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Enter host, group or pattern match.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite local groups and hosts from remote InventorySource.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OverwriteVars</maml:name> <maml:description> <maml:para>Overwrite local variables from remote InventorySource.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>InventorySource SCM branch. Project default used if blank. Only allowed if project `allow_override` field is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Source Type:</maml:para> <maml:para>- `File`: File, Directory or Script - `Constructed`: Template additional groups and hostvars at runtime - `Scm`: Sourced from a Project - `EC2`: Amazon EC2 - `GCE`: Google Compute Engine - `AzureRM`: Microsoft Azure Resource Manager - `VMware`: VMware vCenter - `Satellite6`: Red Hat Satellite 6 - `OpenStack`: OpenStack - `RHV`: Red Hat Virtualization - `Controller`: Red Hat Ansible Automation Platform - `Insights`: Red Hat Insights</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InventorySourceSource</command:parameterValue> <dev:type> <maml:name>InventorySourceSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourcePath</maml:name> <maml:description> <maml:para>Inventory directory, file, or script to load.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceProject</maml:name> <maml:description> <maml:para>Project containing inventory file used as source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceVars</maml:name> <maml:description> <maml:para>InventorySource variables in YAML or JSON format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateCacheTimeout</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateOnLaunch</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>- `0`: Warning - `1`: Info (Default) - `2`: Debug</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InventorySource</maml:name> </dev:type> <maml:description> <maml:para>New created InventorySource object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleInventorySource -Name DemoSource -Inventory 1 -Source Scm -SourceProject 10 -SourcePath inventory/hosts.ini</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleJobTemplate</command:name> <command:verb>New</command:verb> <command:noun>AnsibleJobTemplate</command:noun> <maml:description> <maml:para>Create a JobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a JobTemplate.</maml:para> <maml:para>Implementation of following API: - `/api/v2/job_templates/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowSimultaneous</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskCredential</maml:name> <maml:description> <maml:para>Ask credential on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskDiffMode</maml:name> <maml:description> <maml:para>Ask diff-mode on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskExecutionEnvironment</maml:name> <maml:description> <maml:para>Ask execution environment on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskForks</maml:name> <maml:description> <maml:para>Ask number of forks on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskInventory</maml:name> <maml:description> <maml:para>Ask inventory on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskJobSliceCount</maml:name> <maml:description> <maml:para>Ask job slice count on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskJobType</maml:name> <maml:description> <maml:para>Ask job-type on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLabels</maml:name> <maml:description> <maml:para>Ask labels on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLimit</maml:name> <maml:description> <maml:para>Ask limit on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskScmBranch</maml:name> <maml:description> <maml:para>Ask scm-branch on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskSkipTags</maml:name> <maml:description> <maml:para>Ask skip tags on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskTags</maml:name> <maml:description> <maml:para>Ask job tags on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVariables</maml:name> <maml:description> <maml:para>Ask extra variables on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVerbosity</maml:name> <maml:description> <maml:para>Ask verbosity on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BecomeEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the JobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForceHandlers</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostConfigKey</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the JobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Playbook</maml:name> <maml:description> <maml:para>File path of the playbook in the specified Project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventInstanceGroupFallback</maml:name> <maml:description> <maml:para>If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on. If this setting is enabled and you provided an empty list, the global instance groups will be applied.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartAtTask</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SurveyEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseFactCache</maml:name> <maml:description> <maml:para>If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookCredential</maml:name> <maml:description> <maml:para>Credential ID of Personal Access Token (`github` or `gitlab`) for posting back the status to the service api.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookService</maml:name> <maml:description> <maml:para>Service that webhook requests will be accepted from `github` or `gitlab`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">github</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">gitlab</command:parameterValue> <command:parameterValue required="false" command:variableLength="false"></command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowSimultaneous</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskCredential</maml:name> <maml:description> <maml:para>Ask credential on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskDiffMode</maml:name> <maml:description> <maml:para>Ask diff-mode on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskExecutionEnvironment</maml:name> <maml:description> <maml:para>Ask execution environment on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskForks</maml:name> <maml:description> <maml:para>Ask number of forks on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskInventory</maml:name> <maml:description> <maml:para>Ask inventory on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskJobSliceCount</maml:name> <maml:description> <maml:para>Ask job slice count on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskJobType</maml:name> <maml:description> <maml:para>Ask job-type on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLabels</maml:name> <maml:description> <maml:para>Ask labels on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLimit</maml:name> <maml:description> <maml:para>Ask limit on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskScmBranch</maml:name> <maml:description> <maml:para>Ask scm-branch on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskSkipTags</maml:name> <maml:description> <maml:para>Ask skip tags on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskTags</maml:name> <maml:description> <maml:para>Ask job tags on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVariables</maml:name> <maml:description> <maml:para>Ask extra variables on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVerbosity</maml:name> <maml:description> <maml:para>Ask verbosity on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BecomeEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the JobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForceHandlers</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostConfigKey</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the JobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Playbook</maml:name> <maml:description> <maml:para>File path of the playbook in the specified Project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventInstanceGroupFallback</maml:name> <maml:description> <maml:para>If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on. If this setting is enabled and you provided an empty list, the global instance groups will be applied.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartAtTask</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SurveyEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseFactCache</maml:name> <maml:description> <maml:para>If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookCredential</maml:name> <maml:description> <maml:para>Credential ID of Personal Access Token (`github` or `gitlab`) for posting back the status to the service api.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookService</maml:name> <maml:description> <maml:para>Service that webhook requests will be accepted from `github` or `gitlab`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobTemplate</maml:name> </dev:type> <maml:description> <maml:para>New created JobTemplate object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $inventory = Get-AnsibleInventory -Id 2 PS C:\> $project = Get-AnsibleProject -Id 3 PS C:\> New-AnsibleJobTemplate -Name jobTemplateName1 -Inventory $inventory -Project $project -Playbook path/to/playbok1.yml</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleJobtemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleLabel</command:name> <command:verb>New</command:verb> <command:noun>AnsibleLabel</command:noun> <maml:description> <maml:para>Create a Label.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a Label.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/labels/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleLabel</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Label name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Label name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Label name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Label</maml:name> </dev:type> <maml:description> <maml:para>New created Label object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleLabel -Name TestLabel -Organization 1</dev:code> <dev:remarks> <maml:para>Create a Label named "TestLabel" in Organization ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleNotificationTemplate</command:name> <command:verb>New</command:verb> <command:noun>AnsibleNotificationTemplate</command:noun> <maml:description> <maml:para>Create a NotificationTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a NotificationTemplate.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/notification_templates/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the NotificationTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Value corresponding to NotificationType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the NotificationTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Messages</maml:name> <maml:description> <maml:para>Optional custom messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of Notification</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Email</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Grafana</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IRC</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Mattemost</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pagerduty</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoketChat</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Slack</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Twillo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Webhook</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">NotificationType</command:parameterValue> <dev:type> <maml:name>NotificationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Value corresponding to NotificationType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the NotificationTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Messages</maml:name> <maml:description> <maml:para>Optional custom messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the NotificationTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of Notification</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NotificationType</command:parameterValue> <dev:type> <maml:name>NotificationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para>New created NotificationType object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleNotificationTemplate -Name NotifySlack -Organization 1 -Type Slack -Configuration @{ token = "tokenA"; channles = @("#channel") }</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleOrganization</command:name> <command:verb>New</command:verb> <command:noun>AnsibleOrganization</command:noun> <maml:description> <maml:para>Create an Organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create an Organization.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/organizations/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleOrganization</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxHosts</maml:name> <maml:description> <maml:para>Maximum number of hosts allowed to be managed by the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxHosts</maml:name> <maml:description> <maml:para>Maximum number of hosts allowed to be managed by the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Organization</maml:name> </dev:type> <maml:description> <maml:para>New created Organization object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleOrganization -Name Org2</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleProject</command:name> <command:verb>New</command:verb> <command:noun>AnsibleProject</command:noun> <maml:description> <maml:para>Create a Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a Project.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/projects/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowOverride</maml:name> <maml:description> <maml:para>Allow changing the SCM branch or revision in a job template that uses the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID. Must be `scm` kind credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>The default Execution Environment for jobs run using the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Git</maml:name> <maml:description> <maml:para>Create a "git" type project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specific branch, tag or commit to checkout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmClean</maml:name> <maml:description> <maml:para>Discard any local changes before syncing the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmDeleteOnUpdate</maml:name> <maml:description> <maml:para>Delete the project before syncing.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmRefspec</maml:name> <maml:description> <maml:para>Fit git projects, an additional refspec to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmTrackSubmodules</maml:name> <maml:description> <maml:para>Track submodules latest commits on defined branch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUpdateOnLaunch</maml:name> <maml:description> <maml:para>Update the project when a job is launched that uses the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUrl</maml:name> <maml:description> <maml:para>The location where the project is stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignatureValidationCredential</maml:name> <maml:description> <maml:para>An optional credential used for validating files in the project against unexpected changes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowOverride</maml:name> <maml:description> <maml:para>Allow changing the SCM branch or revision in a job template that uses the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID. Must be `scm` kind credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>The default Execution Environment for jobs run using the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specific branch, tag or commit to checkout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmClean</maml:name> <maml:description> <maml:para>Discard any local changes before syncing the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmDeleteOnUpdate</maml:name> <maml:description> <maml:para>Delete the project before syncing.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUpdateOnLaunch</maml:name> <maml:description> <maml:para>Update the project when a job is launched that uses the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUrl</maml:name> <maml:description> <maml:para>The location where the project is stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignatureValidationCredential</maml:name> <maml:description> <maml:para>An optional credential used for validating files in the project against unexpected changes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Subversion</maml:name> <maml:description> <maml:para>Create a "svn" (Subversion) type project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowOverride</maml:name> <maml:description> <maml:para>Allow changing the SCM branch or revision in a job template that uses the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID. Must be `scm` kind credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>The default Execution Environment for jobs run using the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoteArchive</maml:name> <maml:description> <maml:para>Create a "Remote Archive" type project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmClean</maml:name> <maml:description> <maml:para>Discard any local changes before syncing the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmDeleteOnUpdate</maml:name> <maml:description> <maml:para>Delete the project before syncing.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUpdateOnLaunch</maml:name> <maml:description> <maml:para>Update the project when a job is launched that uses the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUrl</maml:name> <maml:description> <maml:para>The location where the project is stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignatureValidationCredential</maml:name> <maml:description> <maml:para>An optional credential used for validating files in the project against unexpected changes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID. Must be `scm` kind credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>The default Execution Environment for jobs run using the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Insights</maml:name> <maml:description> <maml:para>Create a "insights" (Red Hat Insights) type project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmClean</maml:name> <maml:description> <maml:para>Discard any local changes before syncing the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmDeleteOnUpdate</maml:name> <maml:description> <maml:para>Delete the project before syncing.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUpdateOnLaunch</maml:name> <maml:description> <maml:para>Update the project when a job is launched that uses the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignatureValidationCredential</maml:name> <maml:description> <maml:para>An optional credential used for validating files in the project against unexpected changes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>The default Execution Environment for jobs run using the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignatureValidationCredential</maml:name> <maml:description> <maml:para>An optional credential used for validating files in the project against unexpected changes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>The default Execution Environment for jobs run using the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Local</maml:name> <maml:description> <maml:para>Create a Manual type project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Local path (relative to `PROJECT_ROOT`) containing playbooks and related files for the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignatureValidationCredential</maml:name> <maml:description> <maml:para>An optional credential used for validating files in the project against unexpected changes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowOverride</maml:name> <maml:description> <maml:para>Allow changing the SCM branch or revision in a job template that uses the project.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID. Must be `scm` kind credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>The default Execution Environment for jobs run using the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Git</maml:name> <maml:description> <maml:para>Create a "git" type project.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Insights</maml:name> <maml:description> <maml:para>Create a "insights" (Red Hat Insights) type project.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Local</maml:name> <maml:description> <maml:para>Create a Manual type project.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Local path (relative to `PROJECT_ROOT`) containing playbooks and related files for the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoteArchive</maml:name> <maml:description> <maml:para>Create a "Remote Archive" type project.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specific branch, tag or commit to checkout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmClean</maml:name> <maml:description> <maml:para>Discard any local changes before syncing the project.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmDeleteOnUpdate</maml:name> <maml:description> <maml:para>Delete the project before syncing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmRefspec</maml:name> <maml:description> <maml:para>Fit git projects, an additional refspec to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmTrackSubmodules</maml:name> <maml:description> <maml:para>Track submodules latest commits on defined branch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUpdateOnLaunch</maml:name> <maml:description> <maml:para>Update the project when a job is launched that uses the project.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUrl</maml:name> <maml:description> <maml:para>The location where the project is stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignatureValidationCredential</maml:name> <maml:description> <maml:para>An optional credential used for validating files in the project against unexpected changes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Subversion</maml:name> <maml:description> <maml:para>Create a "svn" (Subversion) type project.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Project</maml:name> </dev:type> <maml:description> <maml:para>New created Project object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleProject -Git -Name GitProject2 -Organization 2 -ScmUrl git@githost:repo1.git -Credential 2</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleSchedule</command:name> <command:verb>New</command:verb> <command:noun>AnsibleSchedule</command:noun> <maml:description> <maml:para>Create a Schedule.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a Schedule for the resource (`Project`, `InventorySource`, `JobTemplate`, `SystemJobTemplate` and `WorkflowJobTemplate`).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/projects/{id}/schedules/` (POST) - `/api/v2/inventory_sources/{id}/schedules/` (POST) - `/api/v2/job_templates/{id}/schedules/` (POST) - `/api/v2/system_job_templates/{id}/schedules/` (POST) - `/api/v2/workflow_job_templates/{id}/schedules/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleSchedule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Turn Diff mode on or off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Create the schedule but as disabled.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraData</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>JobType ("Run" or "Check")</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RRule</maml:name> <maml:description> <maml:para>Scheduling data which has Recurrence Rule a.k.a `RRULE` and starting datetime a.k.a `DTSTART`.</maml:para> <maml:para>See: RFC5545 - 3.3.10. Recurrence Rule (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10)> [!TIP] > Scheduling data can be made from `Jagabata.Schedule.Calendar` and `Jagabata.Schedule.RRule`. > ></maml:para> <maml:para></maml:para> <maml:para>> $calendar = [Jagabata.Schedule.Calendar]::new([datetime]"2025-03-10 21:30") # DTSTART</maml:para> <maml:para>> $rule1 = ([Jagabata.Schedule.RRule]@{ Freq = "Yearly"; }).SetMonth(4).SetMonthDay(1) # April 1 of each year</maml:para> <maml:para>> $rule2 = ([Jagabata.Schedule.RRule]@{ Freq = "Monthly"; Interval = 3 }).SetWeekDay("SA").SetPos(1) # First Saturday of every three months</maml:para> <maml:para>> $calendar.RRules.Add($rule1)</maml:para> <maml:para>> $calendar.RRules.Add($rule2)</maml:para> <maml:para>></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job Tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>Target resource for scheduled execution.</maml:para> <maml:para>Available resource: - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Turn Diff mode on or off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Create the schedule but as disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraData</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>JobType ("Run" or "Check")</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RRule</maml:name> <maml:description> <maml:para>Scheduling data which has Recurrence Rule a.k.a `RRULE` and starting datetime a.k.a `DTSTART`.</maml:para> <maml:para>See: RFC5545 - 3.3.10. Recurrence Rule (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10)> [!TIP] > Scheduling data can be made from `Jagabata.Schedule.Calendar` and `Jagabata.Schedule.RRule`. > ></maml:para> <maml:para></maml:para> <maml:para>> $calendar = [Jagabata.Schedule.Calendar]::new([datetime]"2025-03-10 21:30") # DTSTART</maml:para> <maml:para>> $rule1 = ([Jagabata.Schedule.RRule]@{ Freq = "Yearly"; }).SetMonth(4).SetMonthDay(1) # April 1 of each year</maml:para> <maml:para>> $rule2 = ([Jagabata.Schedule.RRule]@{ Freq = "Monthly"; Interval = 3 }).SetWeekDay("SA").SetPos(1) # First Saturday of every three months</maml:para> <maml:para>> $calendar.RRules.Add($rule1)</maml:para> <maml:para>> $calendar.RRules.Add($rule2)</maml:para> <maml:para>></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job Tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>Target resource for scheduled execution.</maml:para> <maml:para>Available resource: - `Project` - `InventorySource` - `JobTemplate` - `SystemJobTemplate` - `WorkflowJobTemplate`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Schedule</maml:name> </dev:type> <maml:description> <maml:para>New created Schedule object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $jt = Get-AnsibleJobTemplate -Id 10 PS C:\> $rrule = "DTSTART;TZID=Asia/Tokyo:20250310T213000 RRULE:INTERVAL=1;FREQ=YEARLY;BYMONTH=4;BYMONTHDAY=1" PS C:\> New-AnsibleSchedule -Name ScheduleName -RRrule $rrule -Template $jt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $jt = Get-AnsibleJobTemplate -Id 10 PS C:\> $calendar = [Jagabata.Schedule.Calendar]::new([datetime]"2025-03-10 21:30") PS C:\> $rule1 = ([Jagabata.Schedule.RRule]@{ Freq = "Yearly"; }).SetMonth(4).SetMonthDay(1) PS C:\> $calendar.RRules.Add($rule1) PS C:\> $calendar.ToString(); DTSTART;TZID=Asia/Tokyo:20250310T213000 RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTHDAY=1;BYMONTH=4 PS C:\> New-AnsibleSchedule -Name ScheduleName -RRrule $calendar -Template $jt</dev:code> <dev:remarks> <maml:para>The result is the same as in Example 1, but the scheduling rules can be make from `Jagabata.Schedule.Calendar` and `Jagabata.Schedule.RRule`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleTeam</command:name> <command:verb>New</command:verb> <command:noun>AnsibleTeam</command:noun> <maml:description> <maml:para>Create a Team.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a Team.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/teams/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleTeam</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Team.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Team name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Team.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Team name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Team</maml:name> </dev:type> <maml:description> <maml:para>New created Team object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleTeam -Organization 2 -Name DemoTeam1 -Description "でもチーム" Id Type Name Description Created Modified OrganizationName -- ---- ---- ----------- ------- -------- ---------------- 4 Team DemoTeam1 でもチーム 09/11/2024 13:24:09 09/11/2024 13:24:09 TestOrg</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleToken</command:name> <command:verb>New</command:verb> <command:noun>AnsibleToken</command:noun> <maml:description> <maml:para>Create an AccessToken.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create an OAuth2 AccessToken.</maml:para> <maml:para>> [!WARNING] > Be sure to store the result into a variable. > Otherwise, you will not be able to obtain the generated token value.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/applications/{id}/tokens/` (POST) - `/api/v2/users/0/tokens/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Application</maml:name> <maml:description> <maml:para>Application ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the AccessToken.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Allowed scopes, further restricts user's permission.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">read</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">write</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>write</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleToken</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Application</maml:name> <maml:description> <maml:para>Application ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ForMe</maml:name> <maml:description> <maml:para>Create an AccessToken for yourself.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the AccessToken.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Allowed scopes, further restricts user's permission.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">read</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">write</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>write</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleToken</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the AccessToken.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Allowed scopes, further restricts user's permission.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">read</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">write</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>write</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Application</maml:name> <maml:description> <maml:para>Application ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the AccessToken.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ForMe</maml:name> <maml:description> <maml:para>Create an AccessToken for yourself.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Allowed scopes, further restricts user's permission.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>write</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.OAuth2AccessToken</maml:name> </dev:type> <maml:description> <maml:para>New created AccessToken object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $accessToken = New-AnsibleToken -Application (Get-AnsibleApplication -Id 2) -Scope write PS C:\> $accessToken.Token</dev:code> <dev:remarks> <maml:para>Create an AccessToken for the Application of ID 2, and show the created token.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $pat = New-AnsibleToken -ForMe -Scope write -Description "Parsonal Access Token" PS C:\> $pat.Token</dev:code> <dev:remarks> <maml:para>Create a Parsonal Access Token.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleUser</command:name> <command:verb>New</command:verb> <command:noun>AnsibleUser</command:noun> <maml:description> <maml:para>Create a User.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a User.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/users/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential (UserName and Password)</maml:para> <maml:para>See: `Get-Help Get-Credential`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FirstName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSuperUser</maml:name> <maml:description> <maml:para>Designates that the User has all permissions without explicitly assinging them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSystemAuditor</maml:name> <maml:description> <maml:para>Designates that the User is the system auditor.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LastName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FirstName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSuperUser</maml:name> <maml:description> <maml:para>Designates that the User has all permissions without explicitly assinging them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSystemAuditor</maml:name> <maml:description> <maml:para>Designates that the User is the system auditor.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LastName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FirstName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSuperUser</maml:name> <maml:description> <maml:para>Designates that the User has all permissions without explicitly assinging them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSystemAuditor</maml:name> <maml:description> <maml:para>Designates that the User is the system auditor.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LastName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specify `SecureString` object generated by commands such as `ConvertTo-SecureString`. This may be useful for batch operations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential (UserName and Password)</maml:para> <maml:para>See: `Get-Help Get-Credential`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FirstName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSuperUser</maml:name> <maml:description> <maml:para>Designates that the User has all permissions without explicitly assinging them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSystemAuditor</maml:name> <maml:description> <maml:para>Designates that the User is the system auditor.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LastName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specify `SecureString` object generated by commands such as `ConvertTo-SecureString`. This may be useful for batch operations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.User</maml:name> </dev:type> <maml:description> <maml:para>New created User object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleUser -Email teramako@gmail.com cmdlet New-AnsibleUser at command pipeline position 1 Supply values for the following parameters: Credential User: user1 Password for user user1: ********</dev:code> <dev:remarks> <maml:para>Input UserName and Password via prompts.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleUser -Credential (Get-Credential -UserName user2) PowerShell credential request Enter your credentials. Password for user user2: ********</dev:code> <dev:remarks> <maml:para>Input UserName and Password via `Microsoft.PowerShell.Security\Get-Credential`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleUser -UserName user3 -Email teramako@gmail.com <== Password for user3 Password: *******</dev:code> <dev:remarks> <maml:para>Input Password via a prompt.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleWorkflowJobTemplate</command:name> <command:verb>New</command:verb> <command:noun>AnsibleWorkflowJobTemplate</command:noun> <maml:description> <maml:para>Create a WorkflowJobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a WorkflowJobTemplate.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_templates/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowSimultaneous</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskInventory</maml:name> <maml:description> <maml:para>Ask inventory on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLabels</maml:name> <maml:description> <maml:para>Ask labels on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLimit</maml:name> <maml:description> <maml:para>Ask limit on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskScmBranch</maml:name> <maml:description> <maml:para>Ask scm-branch on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskSkipTags</maml:name> <maml:description> <maml:para>Ask skip tags on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskTags</maml:name> <maml:description> <maml:para>Ask job tags on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVariables</maml:name> <maml:description> <maml:para>Ask extra variables on launch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SurveyEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookCredential</maml:name> <maml:description> <maml:para>Credential ID of Personal Access Token (`github` or `gitlab`) for posting back the status to the service api.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookService</maml:name> <maml:description> <maml:para>Service that webhook requests will be accepted from `github` or `gitlab`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">github</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">gitlab</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowSimultaneous</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskInventory</maml:name> <maml:description> <maml:para>Ask inventory on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLabels</maml:name> <maml:description> <maml:para>Ask labels on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLimit</maml:name> <maml:description> <maml:para>Ask limit on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskScmBranch</maml:name> <maml:description> <maml:para>Ask scm-branch on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskSkipTags</maml:name> <maml:description> <maml:para>Ask skip tags on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskTags</maml:name> <maml:description> <maml:para>Ask job tags on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVariables</maml:name> <maml:description> <maml:para>Ask extra variables on launch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SurveyEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookCredential</maml:name> <maml:description> <maml:para>Credential ID of Personal Access Token (`github` or `gitlab`) for posting back the status to the service api.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookService</maml:name> <maml:description> <maml:para>Service that webhook requests will be accepted from `github` or `gitlab`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplate</maml:name> </dev:type> <maml:description> <maml:para>New created WorkflowJobTemplate object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleWorkflowJobTemplate -Name DemoFlow1 -Organization 1</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AnsibleWorkflowJobTemplateNode</command:name> <command:verb>New</command:verb> <command:noun>AnsibleWorkflowJobTemplateNode</command:noun> <maml:description> <maml:para>Create a WorkflowJobTemplateNode.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a WorkflowJobTemplateNode into the WorkflowJobTemplate.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_job_templates/{id}/workflow_nodes/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/success_nodes/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/failure_nodes/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/always_nodes/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/create_approval_template/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowJobtemplate</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ParentNode</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be parent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Upon"> <maml:name>RunUpon</maml:name> <maml:description> <maml:para>Specifies which state ("success", "failure", or "always") the job on the parent node should run in.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">success</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failure</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">always</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>success</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllParentsMustConverge</maml:name> <maml:description> <maml:para>If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identifier</maml:name> <maml:description> <maml:para>An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowJobtemplate</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ParentNode</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be parent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Upon"> <maml:name>RunUpon</maml:name> <maml:description> <maml:para>Specifies which state ("success", "failure", or "always") the job on the parent node should run in.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">success</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failure</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">always</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>success</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllParentsMustConverge</maml:name> <maml:description> <maml:para>If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ApprovalName</maml:name> <maml:description> <maml:para>Name of WorkflowApprovalTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the WorkflowApprovalTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identifier</maml:name> <maml:description> <maml:para>An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowJobtemplate</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ParentNode</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be parent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Upon"> <maml:name>RunUpon</maml:name> <maml:description> <maml:para>Specifies which state ("success", "failure", or "always") the job on the parent node should run in.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">success</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failure</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">always</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>success</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Template"> <maml:name>UnifiedJobTemplate</maml:name> <maml:description> <maml:para>UnifiedJobTemplate (JobTemplate, Project, InventorySource, WorkflowJobTemplate) ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllParentsMustConverge</maml:name> <maml:description> <maml:para>If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraData</maml:name> <maml:description> <maml:para>Extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identifier</maml:name> <maml:description> <maml:para>An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("run" or "check")</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">check</command:parameterValue> <command:parameterValue required="false" command:variableLength="false"></command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllParentsMustConverge</maml:name> <maml:description> <maml:para>If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ApprovalName</maml:name> <maml:description> <maml:para>Name of WorkflowApprovalTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the WorkflowApprovalTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraData</maml:name> <maml:description> <maml:para>Extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identifier</maml:name> <maml:description> <maml:para>An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("run" or "check")</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ParentNode</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be parent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="Upon"> <maml:name>RunUpon</maml:name> <maml:description> <maml:para>Specifies which state ("success", "failure", or "always") the job on the parent node should run in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>success</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="Template"> <maml:name>UnifiedJobTemplate</maml:name> <maml:description> <maml:para>UnifiedJobTemplate (JobTemplate, Project, InventorySource, WorkflowJobTemplate) ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowJobtemplate</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplateNode</maml:name> </dev:type> <maml:description> <maml:para>New created WorkflowJobTemplateNode object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $wjt = Get-AnsibleWorkflowJobTemplate -Id 1 PS C:\> $jt = Get-AnsibleJobTemplate -Id 20 PS C:\> New-AnsibleWorkflowJobTemplateNode -WorkflowJobTemplate $wjt -UnifiedJobTemplate $jt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleWorkflowJobTemplateNode -Id 1 -OutVariables nodes PS C:\> New-AnsibleWorkflowJobTemplateNode -WorkflowJobTemplate 1 -UnifiedJobTemplate 20 -ParentNode $nodes[-1] -RunUpon always</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-AnsibleWorkflowJobTemplateNode -WorkflowJobTemplate 1 -ApprovalName Wait-AnsibleApproval-From-Boss -Timeout 3600</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-AnsibleCredential</command:name> <command:verb>Register</command:verb> <command:noun>AnsibleCredential</command:noun> <maml:description> <maml:para>Register a Credential.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Register a Credential to the specified resource.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/organizations/{id}/galaxy_credentials/` (POST) - `/api/v2/inventory_sources/{id}/credentials/` (POST) - `/api/v2/job_templates/{id}/credentials/` (POST) - `/api/v2/schedules/{id}/credentials/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/credentials/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-AnsibleCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Credential ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>Target resource to be added to.</maml:para> <maml:para>Following resource is available: - `Organization` (galaxy-token only) - `InventorySource` - `JobTemplate` - `Schedule` - `WorkflowJobTemplateNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Credential ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>Target resource to be added to.</maml:para> <maml:para>Following resource is available: - `Organization` (galaxy-token only) - `InventorySource` - `JobTemplate` - `Schedule` - `WorkflowJobTemplateNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Credential ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Register-AnsibleCredential -Id 3 -To @{Type="JobTemplate"; Id=10}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-AnsibleGroup</command:name> <command:verb>Register</command:verb> <command:noun>AnsibleGroup</command:noun> <maml:description> <maml:para>Register a Group to another Group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Register a Group to another Group.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/groups/{id}/children/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-AnsibleGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Group ID to be a child.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>Group ID to be the parent.</maml:para> <maml:para>> [!NOTE] > Can specify `IResource` object. > For example: `-To (Get-AnsibleGroup -Id 10)`, `-To @{ type="group"; id = 10 }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Group ID to be a child.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>Group ID to be the parent.</maml:para> <maml:para>> [!NOTE] > Can specify `IResource` object. > For example: `-To (Get-AnsibleGroup -Id 10)`, `-To @{ type="group"; id = 10 }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Group Id to be a child.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Register-AnsibleGroup -Id 3 -ToGroup 1</dev:code> <dev:remarks> <maml:para>Associate the Group of ID 3 to the Group of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-AnsibleHost</command:name> <command:verb>Register</command:verb> <command:noun>AnsibleHost</command:noun> <maml:description> <maml:para>Register a Host to a Group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Register a User to a Group.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/groups/{id}/hosts/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-AnsibleHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>Parent Group Id.</maml:para> <maml:para>> [!NOTE] > Can specify `IResource` object. > For example: `-To (Get-AnsibleGroup -Id 10)`, `-To @{ type="group"; id = 10 }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>Parent Group Id.</maml:para> <maml:para>> [!NOTE] > Can specify `IResource` object. > For example: `-To (Get-AnsibleGroup -Id 10)`, `-To @{ type="group"; id = 10 }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Register-AnsibleHost -Id 3 -To 1</dev:code> <dev:remarks> <maml:para>Associate the Host of ID 3 to the Group of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-AnsibleLabel</command:name> <command:verb>Register</command:verb> <command:noun>AnsibleLabel</command:noun> <maml:description> <maml:para>Register a Label to other resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Register a Label to the target resource.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventories/{id}/labels/` (POST) - `/api/v2/job_templates/{id}/labels/` (POST) - `/api/v2/schedules/{id}/labels/` (POST) - `/api/v2/workflow_job_templates/{id}/labels/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/labels/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-AnsibleLabel</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Label ID to be registered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>The resource to which registered.</maml:para> <maml:para>Following resource is available: - `Inventory` - `JobTemplate` - `Schedule` - `WorkflowJobTemplate` - `WorkflowJobTemplateNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Label ID to be registered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>The resource to which registered.</maml:para> <maml:para>Following resource is available: - `Inventory` - `JobTemplate` - `Schedule` - `WorkflowJobTemplate` - `WorkflowJobTemplateNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Label ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Register-AnsibleLabel -To (Get-AnsibleInventory -Id 2) -Id 1</dev:code> <dev:remarks> <maml:para>Associate the Label of ID 1 to the Inventory of ID 2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-AnsibleSurveySpec</command:name> <command:verb>Register</command:verb> <command:noun>AnsibleSurveySpec</command:noun> <maml:description> <maml:para>Register SurveySpecs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Register SurveySpecs to the target Template (JobTemplate or WorkflowJobTemplate).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/job_templates/{id}/survey_spec/` (POST) - `/api/v2/workflow_job_templates/{id}/survey_spec/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-AnsibleSurveySpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>JobTemplate or WorkflowJobTemplate object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Survey.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional name of the Survey.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Spec</maml:name> <maml:description> <maml:para>Array of `SurveySpec` objects.</maml:para> <maml:para>`SurveySpec` properties: - `Type`: - `Text`: For survey questions expecting a textual answer (Default). - `Textarea`: For survey questions expecting a multiline textual answer. - `Password`: For survey questions expecting a password or other sensitive information. - `Integer`: For survey questions expecting a whole number answer. - `Float`: For survey questions expecting a decimal number. - `MultipleChoice`: For survey questions where one option from a list is required. - `MultiSelect`: For survey questions where multiple items from a presented list can be selected. - `Name`: The question to ask the user. - `Description`: Optional description of the question. - `Variable`: Variable name to store the response. This is the variable to be used by the playbook. Variable names cannot contain spaces. - `Required`: Whether or not an answer to the question is required. - `Default`: Default value of the question - `Choices`: Array of the question's choices for `MultipleChoice` or `MultiSelect`, - `Min`: Minimum number or string length (Default = 0) - `Max`: Maximum number or string length (Default = 1024)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SurveySpec[]</command:parameterValue> <dev:type> <maml:name>SurveySpec[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Register-AnsibleSurveySpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>JobTemplate or WorkflowJobTemplate object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Survey</maml:name> <maml:description> <maml:para>Object containing a `Spec` array, `Name` and `Description` which can create with `Jagabata.Survey.Survey` or `Jagabata.Resources.Survey`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Survey</command:parameterValue> <dev:type> <maml:name>Survey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Register-AnsibleSurveySpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>JobTemplate or WorkflowJobTemplate object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Survey.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional name of the Survey.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Spec</maml:name> <maml:description> <maml:para>Array of `SurveySpec` objects.</maml:para> <maml:para>`SurveySpec` properties: - `Type`: - `Text`: For survey questions expecting a textual answer (Default). - `Textarea`: For survey questions expecting a multiline textual answer. - `Password`: For survey questions expecting a password or other sensitive information. - `Integer`: For survey questions expecting a whole number answer. - `Float`: For survey questions expecting a decimal number. - `MultipleChoice`: For survey questions where one option from a list is required. - `MultiSelect`: For survey questions where multiple items from a presented list can be selected. - `Name`: The question to ask the user. - `Description`: Optional description of the question. - `Variable`: Variable name to store the response. This is the variable to be used by the playbook. Variable names cannot contain spaces. - `Required`: Whether or not an answer to the question is required. - `Default`: Default value of the question - `Choices`: Array of the question's choices for `MultipleChoice` or `MultiSelect`, - `Min`: Minimum number or string length (Default = 0) - `Max`: Maximum number or string length (Default = 1024)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SurveySpec[]</command:parameterValue> <dev:type> <maml:name>SurveySpec[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Survey</maml:name> <maml:description> <maml:para>Object containing a `Spec` array, `Name` and `Description` which can create with `Jagabata.Survey.Survey` or `Jagabata.Resources.Survey`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Survey</command:parameterValue> <dev:type> <maml:name>Survey</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>JobTemplate or WorkflowJobTemplate object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>JobTemplate or WorkflowJobTemplate object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $jt = Get-AnsibleJobTemplate -Id 10 PS C:\> Register-AnsibleSurveySpec $jt -Spec @{Name="User name";Variable="user";Required=$true},@{Name="Password";Variable="pass";Type="password";Required=$true}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $jt = Get-AnsibleJobTemplate -Id 10 PS C:\> $survey = $jt | Get-AnsibleSurveySpec PS C:\> $survey.Spec += @{ Name="Select an animal"; Variable="animal"; Choices=@("cat","doc"); Type="multiplechoice" } PS C:\> $jt | Register-AnsibleSurveySpec -Spec $survey.Spec</dev:code> <dev:remarks> <maml:para>Add multiple choice survey and re-register.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $jt = Get-AnsibleJobTemplate -Id 10 PS C:\> $survey = New-Object Jagabata.Survey.Survey -Property @{ Name = "Survey Name"; Description = "" } PS C:\> $survey.Spec += New-Object Jagabata.Survey.TextSpec -ArgumentList "1.User","username" -Property @{ Required = $true; Default = "user1" } PS C:\> $survey.Spec += New-Object Jagabata.Survey.PasswordSpec -ArgumentList "2.Password","pass" -Property @{ Required = $true; } PS C:\> $jt | Register-AnsibleSurveySpec -Spec $survey</dev:code> <dev:remarks> <maml:para>Register surveys created with Class.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSurveySpec</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleSurveySpec</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-AnsibleUser</command:name> <command:verb>Register</command:verb> <command:noun>AnsibleUser</command:noun> <maml:description> <maml:para>Register a Uesr to other resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Register a User to the specified resource (`Organization`, `Team`, or `Role`).</maml:para> <maml:para>Implements following Rest API: - `/api/v2/organizations/{id}/users/` (POST) - `/api/v2/teams/{id}/users/` (POST) - `/api/v2/roles/{id}/users/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-AnsibleUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>User ID to be registered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>The resource to which registered.</maml:para> <maml:para>Following resource is available: - `Organization` - `Team` - `Role`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>User ID to be registered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>The resource to which registered.</maml:para> <maml:para>Following resource is available: - `Organization` - `Team` - `Role`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>User ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Register-AnsibleUser -Id 2 -To (Get-AnsibleOrganization -Id 1)</dev:code> <dev:remarks> <maml:para>Associate the User of ID 2 to the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-AnsibleWorkflowJobTemplateNode</command:name> <command:verb>Register</command:verb> <command:noun>AnsibleWorkflowJobTemplateNode</command:noun> <maml:description> <maml:para>Link WorkflowJobTemplateNode to the parent.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Link WorkflowJobTemplateNode to the parent.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_job_template_nodes/{id}/success_nodes/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/failure_nodes/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/always_nodes/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be child.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Upon"> <maml:name>RunUpon</maml:name> <maml:description> <maml:para>Specifies which state ("success", "failure", or "always") the job on the parent node should run in.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">success</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">failure</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">always</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>success</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be parent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be child.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Upon"> <maml:name>RunUpon</maml:name> <maml:description> <maml:para>Specifies which state ("success", "failure", or "always") the job on the parent node should run in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>success</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>To</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be parent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be child.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Register-AnsibleWorkflowJobTemplateNode -Id 2 -To 1 -RunUpon always</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleAdHocCommandJob</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleAdHocCommandJob</command:noun> <maml:description> <maml:para>Remove an AdHocCommand job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an AdHocCommand job.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/ad_hoc_commands/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleAdHocCommandJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>AdHocCommand job ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>AdHocCommand job ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>AdHocCommand job ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleAdHocCommandJob -Id 30</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleAdHocCommandJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleApplication</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleApplication</command:noun> <maml:description> <maml:para>Remove an Application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an Application.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/applications/{id}/` (DELETE) </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Application ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Application ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Application ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleApplication -Id 3</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleCredential</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleCredential</command:noun> <maml:description> <maml:para>Remove a Credential.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a Credential.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/credentials/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Credential ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Credential ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Credential ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleCredential -Id 2</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleCredentialType</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleCredentialType</command:noun> <maml:description> <maml:para>Remove a CredentialType.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a Team.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/credential_types/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleCredentialType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>CredentialType ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>CredentialType ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>CredentialType ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleCredentialType -Id 30</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleExecutionEnvironment</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleExecutionEnvironment</command:noun> <maml:description> <maml:para>Remove an ExecutionEnvironment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an ExecutionEnvironment.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/execution_environments/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleExecutionEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleExecutionEnvironment -Id 4</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleGroup</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleGroup</command:noun> <maml:description> <maml:para>Remove a Group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove the Group.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/groups/{id}/` (DELETE) </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Group Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Group Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Group Id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleGroup -Id 3</dev:code> <dev:remarks> <maml:para>Delete completly the Group of ID 3.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleHost</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleHost</command:noun> <maml:description> <maml:para>Remove a Host</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a Host.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/hosts/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleHost -Id 3</dev:code> <dev:remarks> <maml:para>Delete completly the Host of ID 3.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleInventory</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleInventory</command:noun> <maml:description> <maml:para>Remove an Inventory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an Inventory.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventories/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Inventory ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Inventory ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Inventory Id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleInventory -Id 2</dev:code> <dev:remarks> <maml:para>Delete completly the Inventory of ID 2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleInventorySource</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleInventorySource</command:noun> <maml:description> <maml:para>Remove an InventorySource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an InventorySource.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventory_sources/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleInventorySource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>InventorySource ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleInventorySource -Id 10</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleInventoryUpdateJob</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleInventoryUpdateJob</command:noun> <maml:description> <maml:para>Remove an InventoryUpdate job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an InventoryUpdate Job.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventory_updates/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleInventoryUpdateJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventoryUpdate job ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventoryUpdate job ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>InventoryUpdate job ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleInventoryUpdate -Id 30</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleJob</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleJob</command:noun> <maml:description> <maml:para>Remove a JobTemplate job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a JobTemplate job.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/jobs/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate job ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate job ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>JobTemplate job ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleJob -Id 30</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleJobTemplate</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleJobTemplate</command:noun> <maml:description> <maml:para>Remove a JobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a JobTemplate.</maml:para> <maml:para>Implementation of following API: - `/api/v2/job_templates/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleJobTemplate -Id 4</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleJobtemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleNotificationTemplate</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleNotificationTemplate</command:noun> <maml:description> <maml:para>Remove a NotificationTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a NotificationTemplate.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/notification_templates/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>NotificationTemplate ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>NotificationTemplate ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>NotificationTemplate ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleNotificationTemplate -Id 4</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleOrganization</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleOrganization</command:noun> <maml:description> <maml:para>Remove an Organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an Organization.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/organizations/{id}/` (DELETE) </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleOrganization</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Organization ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Organization ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleOrganization -Id 2</dev:code> <dev:remarks> <maml:para>Remove the Organization of ID 2 completely.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleProject</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleProject</command:noun> <maml:description> <maml:para>Remove a Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a Project.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/projects/{id}/` (DELETE) </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Project ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleProject -Id 10</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleProjectUpdateJob</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleProjectUpdateJob</command:noun> <maml:description> <maml:para>Remove a ProjectUpdate Job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a ProjectUpdate Job.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/project_updates/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleProjectUpdateJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ProjectUpdate job ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ProjectUpdate job ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>ProjectUpdate job ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleProjectUpdateJob -Id 30</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProjectUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleSchedule</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleSchedule</command:noun> <maml:description> <maml:para>Remove a Schedule.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a Schedule.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/schedules/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Schedule ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore comfirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore comfirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Schedule ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleSchedule -Id 10</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleSurveySpec</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleSurveySpec</command:noun> <maml:description> <maml:para>Remove SurveySpecs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove SurveySpecs from the JobTemplate or WorkflowJobTemplate</maml:para> <maml:para>Implements following Rest API: - `/api/v2/job_templates/{id}/survey_spec/` (DELETE) - `/api/v2/workflow_job_templates/{id}/survey_spec/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleSurveySpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>JobTemplate or WorkflowJobTemplate object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>JobTemplate or WorkflowJobTemplate object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>JobTemplate or WorkflowJobTemplate object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $jt = Get-AnsibleJobTemplate -Id 10 PS C:\> Remove-AnsibleSurveySpec $jt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSurveySpec</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleSurveySpec</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleSystemJob</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleSystemJob</command:noun> <maml:description> <maml:para>Remove a System job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a System job.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/system_jobs/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleSystemJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>SystemJob ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>SystemJob ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>SystemJob ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleSystemJob -Id 30</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleTeam</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleTeam</command:noun> <maml:description> <maml:para>Remove a Team</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a Team.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/teams/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleTeam</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Team ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Team ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Team ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleTeam -Id 2</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleToken</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleToken</command:noun> <maml:description> <maml:para>Remove an AccessToken.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an AccessToken.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/tokens/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>AccessToken ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>AccessToken ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>AccessToken ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleToken -Id 3</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleUser</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleUser</command:noun> <maml:description> <maml:para>Remove a User</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a User.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/users/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>User ID to be removed or disassosicated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>User ID to be removed or disassosicated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>User ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleUser -Id 2</dev:code> <dev:remarks> <maml:para>Remove the User of ID 2 completely.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleWorkflowApprovalRequest</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleWorkflowApprovalRequest</command:noun> <maml:description> <maml:para>Remove a WorkflowApproval.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a WorkflowApproval.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_approvals/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleWorkflowApprovalRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowApproval ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowApproval ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowApproval ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleWorkflowApprovalRequest -Id 30</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Approve-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Deny-AnsibleWorkflowApprovalRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleWorkflowJob</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleWorkflowJob</command:noun> <maml:description> <maml:para>Remove a Workflow job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a Workflow job.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_jobs/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleWorkflowJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJob ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJob ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJob ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleWorkflowJob -Id 30</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleWorkflowJobTemplate</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleWorkflowJobTemplate</command:noun> <maml:description> <maml:para>Remove a WorkflowJobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a WorkflowJobTemplate.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_templates/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Ignore confirmination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplate ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleWorkflowJobTemplate -Id 3</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AnsibleWorkflowJobTemplateNode</command:name> <command:verb>Remove</command:verb> <command:noun>AnsibleWorkflowJobTemplateNode</command:noun> <maml:description> <maml:para>Remove a WorkflowJobTemplateNode.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a WorkflowJobTemplateNode.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_job_template_nodes/{id}/` (DELETE)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Don't confirm. (Ignore `-Confirm` and `-WhatIf`)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplateNode ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleWorkflowJobTemplateNode -Id 30</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Revoke-AnsibleRole</command:name> <command:verb>Revoke</command:verb> <command:noun>AnsibleRole</command:noun> <maml:description> <maml:para>Revoke Roles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Revoke Roles from a User or Team.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/users/{id}/roles/` (POST) - `/api/v2/teams/{id}/roles/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Revoke-AnsibleRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Target role objects to be revoked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource[]</command:parameterValue> <dev:type> <maml:name>IResource[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Target resource (`User` or `Team`) to be revoked from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Target resource (`User` or `Team`) to be revoked from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Target role objects to be revoked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource[]</command:parameterValue> <dev:type> <maml:name>IResource[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource[]</maml:name> </dev:type> <maml:description> <maml:para>Role objects to be revoked.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $grantedRoles = Find-AnsibleRole -Type User -Id 2 PS C:\> $user = Get-AnsibleUser -Id 2 PS C:\> Revoke-AnsibleRole -Roles ($grantedRoles | Where Name -match admin) -From $user</dev:code> <dev:remarks> <maml:para>Revoke all roles that contain "admin" in the role name from the user of ID 2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleObjectRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Grant-AnsibleRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-AnsibleSchedule</command:name> <command:verb>Show</command:verb> <command:noun>AnsibleSchedule</command:noun> <maml:description> <maml:para>Preview scheduled datetimes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Preview scheduled datetimes. (Max 10)</maml:para> <maml:para>Implements following Rest API: - `/api/v2/schedules/preview/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-AnsibleSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>RRule</maml:name> <maml:description> <maml:para>Scheduling data which has Recurrence Rule a.k.a `RRULE` and starting datetime a.k.a `DTSTART`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Show-AnsibleSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Schedule object which is retrieved with `Get-AnsibleSchedule` or `Find-AnsibleSchedule`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Schedule</command:parameterValue> <dev:type> <maml:name>Schedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>RRule</maml:name> <maml:description> <maml:para>Scheduling data which has Recurrence Rule a.k.a `RRULE` and starting datetime a.k.a `DTSTART`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Schedule object which is retrieved with `Get-AnsibleSchedule` or `Find-AnsibleSchedule`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Schedule</command:parameterValue> <dev:type> <maml:name>Schedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Scheduling data which has Recurrence Rule a.k.a `RRULE` and starting datetime a.k.a `DTSTART`.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Schedule</maml:name> </dev:type> <maml:description> <maml:para>Schedule object which is retrieved with `Get-AnsibleSchedule` or `Find-AnsibleSchedule`.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.SchedulePreview</maml:name> </dev:type> <maml:description> <maml:para>An objects with up to 10 most recent scheduled datetimes, each with a local date and UTC date</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Show-AnsibleSchedule -RRule "DTSTART;TZID=Asia/Tokyo:20250101T000000 RRULE:INTERVAL=1;FREQ=MONTHLY;BYMONTHDAY=1,-1;BYHOUR=9" Local Utc ----- --- 2025-01-01T09:00:00+09:00 2025-01-01T00:00:00Z 2025-01-31T09:00:00+09:00 2025-01-31T00:00:00Z 2025-02-01T09:00:00+09:00 2025-02-01T00:00:00Z 2025-02-28T09:00:00+09:00 2025-02-28T00:00:00Z 2025-03-01T09:00:00+09:00 2025-03-01T00:00:00Z 2025-03-31T09:00:00+09:00 2025-03-31T00:00:00Z 2025-04-01T09:00:00+09:00 2025-04-01T00:00:00Z 2025-04-30T09:00:00+09:00 2025-04-30T00:00:00Z 2025-05-01T09:00:00+09:00 2025-05-01T00:00:00Z 2025-05-31T09:00:00+09:00 2025-05-31T00:00:00Z</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleSchedule -Id 3 | Show-AnsibleSchedule</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-AnsibleAdHocCommand</command:name> <command:verb>Start</command:verb> <command:noun>AnsibleAdHocCommand</command:noun> <maml:description> <maml:para>Invoke (launch) an AdHocCommand.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Launch an AdHocCommand. This command only sends a request to launch an AdHocCommand, not wait for the job is completed. So, the returned job object will be non-completed status. Use `Wait-AnsibleUnifiedJob` command to wait for the job to complete later.</maml:para> <maml:para>Implementation of following API: - `/api/v2/inventories/{id}/ad_hoc_commands/` - `/api/v2/groups/{id}/ad_hoc_commands/` - `/api/v2/hosts/{id}/ad_hoc_commands/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Group</command:parameterValue> <dev:type> <maml:name>Group</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Host</maml:name> <maml:description> <maml:para>Host to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Host</command:parameterValue> <dev:type> <maml:name>Host</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Inventory</command:parameterValue> <dev:type> <maml:name>Inventory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleAdHocCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InventoryId</maml:name> <maml:description> <maml:para>Inventory ID to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Luanch as `Check` mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID of Machine type for executing command to the remote hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Group</command:parameterValue> <dev:type> <maml:name>Group</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Host</maml:name> <maml:description> <maml:para>Host to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Host</command:parameterValue> <dev:type> <maml:name>Host</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Inventory</command:parameterValue> <dev:type> <maml:name>Inventory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InventoryId</maml:name> <maml:description> <maml:para>Inventory ID to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ModuleArgs</maml:name> <maml:description> <maml:para>The action's (`-ModuleName`) options in space separated `k=v` format or JSON format.</maml:para> <maml:para>e.g.) - `opt1=val1 opt=2=val2` - `{"opt1": "val1", "opt2": "val2"}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:description> <maml:para>Name of the action to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Host</maml:name> </dev:type> <maml:description> <maml:para>Host object to be executed.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Group</maml:name> </dev:type> <maml:description> <maml:para>Group object to be executed.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Inventory</maml:name> </dev:type> <maml:description> <maml:para>Inventory object to be executed.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Inventory ID to be executed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.AdHocCommand</maml:name> </dev:type> <maml:description> <maml:para>AdHocCommand job object (non-completed status)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-AnsibleGroup -Id 1 | Start-AnsibleAdHocCommand -ModuleName ping -Credential 1 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 120 AdHocCommand ping run Manual New 0 [user][1]admin ping {[ModuleArgs, ], [Limit, TestGroup], [Inventory, [2]TestInventory]}</dev:code> <dev:remarks> <maml:para>Launch `ping` ansible module to the Group ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-AnsibleInventoryUpdate</command:name> <command:verb>Start</command:verb> <command:noun>AnsibleInventoryUpdate</command:noun> <maml:description> <maml:para>Invoke (update) InventorySources.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update InventorySources. Multiple InventorySources in the Inventory may be udpated, when an Inventory is specified bye `-Inventory` parameter.</maml:para> <maml:para>This command only sends a request to update InventorySources, not wait for the job is completed. So, the returned job object will be non-completed status. Use `Wait-AnsibleUnifiedJob` command to wait for the job to complete later.</maml:para> <maml:para>Implementation of following API: - `/api/v2/inventory_sources/{id}/update/` - `/api/v2/inventries/{id}/update_inventory_sources/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AnsibleInventoryUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter InventorySource(s) can be updated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleInventoryUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>A `Inventory` or `InventorySource` object.</maml:para> <maml:para>If the value is `Inventory`, all of InventorySources in the Inventory will be updated or checked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter InventorySource(s) can be updated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleInventoryUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleInventoryUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>A `Inventory` or `InventorySource` object.</maml:para> <maml:para>If the value is `Inventory`, all of InventorySources in the Inventory will be updated or checked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter InventorySource(s) can be updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>A `Inventory` or `InventorySource` object.</maml:para> <maml:para>If the value is `Inventory`, all of InventorySources in the Inventory will be updated or checked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>InventorySource ID</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.InventorySource</maml:name> </dev:type> <maml:description> <maml:para>InventorySource object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Inventory</maml:name> </dev:type> <maml:description> <maml:para>Inventory object containing the InventorySources to be updated.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InventoryUpdateJob+Detail</maml:name> </dev:type> <maml:description> <maml:para>InventoryUpdate job object (non-completed status)</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>Results of checked wheter the InventorySources can be updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Start-AnsibleInventoryUpdate -Id 11 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 130 InventoryUpdate TestInventory - test_source Manual Pending 0 [user][1]admin [11]test_source {[Inventory, [2]TestInventory], [Source, Scm], [SourcePath, inventory/hosts.ini]}</dev:code> <dev:remarks> <maml:para>Update an InventorySource ID 11.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-AnsibleInventoryUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventoryUpdateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-AnsibleJobTemplate</command:name> <command:verb>Start</command:verb> <command:noun>AnsibleJobTemplate</command:noun> <maml:description> <maml:para>Invoke (launch) a JobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Launch a JobTemplate.</maml:para> <maml:para>This command only sends a request to start JobTemplate, not wait for the job is completed. So, the returned job object will be non-completed status. Use `Wait-AnsibleUnifiedJob` command to wait for the job to complete later.</maml:para> <maml:para>Implementation of following API: - `/api/v2/job_templates/{id}/launch/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AnsibleJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Specify credential IDs.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Specify diff mode.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>Specify ExecutionEnvironment ID.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Specify the number of forks.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Specify the number of job slice count.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specify timeout value (seconds).</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Specify job verbosity.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Specify credential IDs.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Specify diff mode.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>Specify ExecutionEnvironment ID.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Specify the number of forks.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Specify the number of job slice count.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specify timeout value (seconds).</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Specify job verbosity.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>JobTemplate</maml:name> <maml:description> <maml:para>JobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Specify credential IDs.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Specify diff mode.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>Specify ExecutionEnvironment ID.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Specify the number of forks.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Specify the number of job slice count.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specify timeout value (seconds).</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Specify job verbosity.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Specify credential IDs.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Specify diff mode.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>Specify ExecutionEnvironment ID.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Specify the number of forks.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Specify the number of job slice count.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>JobTemplate</maml:name> <maml:description> <maml:para>JobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specify timeout value (seconds).</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Specify job verbosity.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>JobTemplate ID to be launched.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.JobTemplate</maml:name> </dev:type> <maml:description> <maml:para>JobTemplate object to be launched.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobTemplateJob+LaunchResult</maml:name> </dev:type> <maml:description> <maml:para>The result job object of lanched the JobTemplate (non-completed status)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> > Start-AnsibleJobtemplate -Id 7 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 101 Job Demo Job Template Run Manual Pending 2024/08/06 15:19:01 1.983 [user][1]admin [7]Demo Job Template {[Playbook, hello_world.yml], [Artifacts, {}], [Labels, ]}</dev:code> <dev:remarks> <maml:para>Launch JobTemplate ID 7.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> > Start-AnsibleJobtemplate -Id 7 | Wait-AnsibleUnifiedJob [7] Demo Job Template - Inventory : [1] Demo Inventory Extra vars : --- Diff Mode : False Job Type : Run Verbosity : 0 (Normal) Credentials : [1] Demo Credential Forks : 0 Job Slice Count : 1 Timeout : 0 ====== [102] Demo Job Template ====== PLAY [Hello World Sample] ****************************************************** TASK [Gathering Facts] ********************************************************* ok: [localhost] TASK [Hello Message] *********************************************************** ok: [localhost] => { "msg": "Hello World!" } PLAY RECAP ********************************************************************* localhost : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 102 Job Demo Job Template Run Manual Successful 2024/08/07 9:53:56 1.968 [user][1]admin [7]Demo Job Template {[Playbook, hello_world.yml], [Artifacts, {}], [Labels, ]}</dev:code> <dev:remarks> <maml:para>Launch JobTemplate ID 7, and wait unti for the job is finished. This is almost same as `Invoke-AnsibleJobTemplate` command.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-AnsibleProjectUpdate</command:name> <command:verb>Start</command:verb> <command:noun>AnsibleProjectUpdate</command:noun> <maml:description> <maml:para>Invoke (update) Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Project.</maml:para> <maml:para>This command only sends a request to update Project, not wait for the job is completed. So, the returned job object will be non-completed status. Use `Wait-AnsibleUnifiedJob` command to wait for the job to complete later.</maml:para> <maml:para>Implementation of following API: - `/api/v2/projects/{id}/update/` </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AnsibleProjectUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter a Project can be updated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleProjectUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project object to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter a Project can be updated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleProjectUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleProjectUpdate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project object to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Check</maml:name> <maml:description> <maml:para>Check wheter a Project can be updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project object to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.Project</maml:name> </dev:type> <maml:description> <maml:para>Project object to be updated.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ProjectUpdateJob+Detail</maml:name> </dev:type> <maml:description> <maml:para>The result job object of updated the Project (non-completed status).</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>Results of checked wheter the Project can be updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-AnsibleProjectUpdate -Id 8 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 100 ProjectUpdate proj_1 Check Manual Pending 2024/08/06 15:34:34 1.888 [user][1]admin [8][git]proj_1 {[Branch, master], [Revision, ***], [Url, ***]}</dev:code> <dev:remarks> <maml:para>Update a Project ID 8.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-AnsibleProjectUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleProjectUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProjectUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-AnsibleSystemJobTemplate</command:name> <command:verb>Start</command:verb> <command:noun>AnsibleSystemJobTemplate</command:noun> <maml:description> <maml:para>Invoke (launch) a SystemJobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Launch a SystemJobTemplate.</maml:para> <maml:para>This command only sends a request to start SystemJobTemplate, not wait for the job is completed. So, the returned job object will be non-completed status. Use `Wait-AnsibleUnifiedJob` command to wait for the job to complete later.</maml:para> <maml:para>Implementation of following API: - `/api/v2/system_job_templates/{id}/launch/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AnsibleSystemJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Variables to be passed to the system job task as command line parameters.</maml:para> <maml:para>For excample: - `@{ dry_run: $true }` : for `cleanup_jobs` and `cleanup_activitystream` - `@{ days: 90 }'` : for `cleanup_jobs` and `cleanup_activitystream`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleSystemJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>SystemJobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Variables to be passed to the system job task as command line parameters.</maml:para> <maml:para>For excample: - `@{ dry_run: $true }` : for `cleanup_jobs` and `cleanup_activitystream` - `@{ days: 90 }'` : for `cleanup_jobs` and `cleanup_activitystream`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleSystemJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SystemJobTemplate</maml:name> <maml:description> <maml:para>{{ Fill SystemJobTemplate Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Variables to be passed to the system job task as command line parameters.</maml:para> <maml:para>For excample: - `@{ dry_run: $true }` : for `cleanup_jobs` and `cleanup_activitystream` - `@{ days: 90 }'` : for `cleanup_jobs` and `cleanup_activitystream`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Variables to be passed to the system job task as command line parameters.</maml:para> <maml:para>For excample: - `@{ dry_run: $true }` : for `cleanup_jobs` and `cleanup_activitystream` - `@{ days: 90 }'` : for `cleanup_jobs` and `cleanup_activitystream`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>SystemJobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SystemJobTemplate</maml:name> <maml:description> <maml:para>{{ Fill SystemJobTemplate Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>SystemJobTemplate ID to be launched.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.SystemJobTemplate</maml:name> </dev:type> <maml:description> <maml:para>SystemJobTemplate object to be launched.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.SystemJob+Detail</maml:name> </dev:type> <maml:description> <maml:para>The result job object of lanched the SystemJobTemplate (non-completed status).</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Start-AnsibleSystemJobTemplate -Id 4 ====== [110] Cleanup Expired Sessions ====== Expired Sessions deleted 2 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 110 SystemJob Cleanup Expired Sessions cleanup_sessions Manual Pending 2024/08/06 15:56:27 1.793 [user][1]admin [4]Cleanup Expired Sessions {[ExtraVars, {}], [Stdout, Expired Sessions deleted 2…</dev:code> <dev:remarks> <maml:para>Launch JobTemplate ID 4.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSystemJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-AnsibleWorkflowJobTemplate</command:name> <command:verb>Start</command:verb> <command:noun>AnsibleWorkflowJobTemplate</command:noun> <maml:description> <maml:para>Invoke (update) a WorkflowJobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Launch a WorkflowJobTemplate. Multiple InventorySources in the Inventory may be udpated, when an Inventory is specified bye `-Inventory` parameter.</maml:para> <maml:para>This command only sends a request to start WorkflowJobTemplate, not wait for the job is completed. So, the returned job object will be non-completed status. Use `Wait-AnsibleUnifiedJob` command to wait for the job to complete later.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_templates/{id}/launch/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowJobTemplate</maml:name> <maml:description> <maml:para>WorkflowJobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>"Prompt on launch" prompts for checked items. (However, it will not prompt for items that have already been given as parameters.)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Labels</maml:name> <maml:description> <maml:para>Label IDs</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue> <dev:type> <maml:name>UInt64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if the Project's `AllowOverride` flag is on and "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Specify skip tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specify tags. (commas `,` separated)</maml:para> <maml:para>> [!NOTE] > This parameter will be ignored if "Ask" flag is off, although the request will be sent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>WorkflowJobTemplate</maml:name> <maml:description> <maml:para>WorkflowJobTempalte object to be launched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplate ID to be launched.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplate</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplate object to be launched.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJob+LaunchResult</maml:name> </dev:type> <maml:description> <maml:para>The result job object of lanched the WorkflowJobTemplate (non-completed status).</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Start-AnsibleWorkflowJobTemplate -Id 13 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 110 WorkflowJob TestWorkflow Manual Pending 2024/08/06 16:21:10 4.202 [user][1]admin [13]TestWorkflow {[Labels, test], [Inventory, [2]], [Limit, ], [Branch, ]…}</dev:code> <dev:remarks> <maml:para>Launch WorkflowJobTemplate ID 13.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-AnsibleUnifiedJob</command:name> <command:verb>Stop</command:verb> <command:noun>AnsibleUnifiedJob</command:noun> <maml:description> <maml:para>Stop (cancel) a running job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stop a running job. This command only sends a request to cancel a job. AWX/AnsibleTower may response an error if not acceptable.</maml:para> <maml:para>Can determine whether the job is cancelable with `-Determine` parameter.</maml:para> <maml:para>Implementation of following API: - `/api/v2/jobs/{id}/cancel/` - `/api/v2/project_updates/{id}/cancel/` - `/api/v2/inventory_updates/{id}/cancel/` - `/api/v2/system_jobs/{id}/cancel/` - `/api/v2/ad_hoc_commands/{id}/cancel/` - `/api/v2/workflow_jobs/{id}/cancel/`</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AnsibleUnifiedJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Determine</maml:name> <maml:description> <maml:para>Determine whether the job is canelable, instead of requesting cancel.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-AnsibleUnifiedJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProjectUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventoryUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AdHocCommand</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJob</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Job ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Determine</maml:name> <maml:description> <maml:para>Determine whether the job is canelable, instead of requesting cancel.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-AnsibleUnifiedJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>UnifiedJob resource object from which to stop.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `WorkflowJob` : WorkflowJobTemplate's job - `SystemJob` : SystemJobTemplate's job</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Determine</maml:name> <maml:description> <maml:para>Determine whether the job is canelable, instead of requesting cancel.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Determine</maml:name> <maml:description> <maml:para>Determine whether the job is canelable, instead of requesting cancel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Job ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>UnifiedJob resource object from which to stop.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `WorkflowJob` : WorkflowJobTemplate's job - `SystemJob` : SystemJobTemplate's job</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>The object has `Id` and `Type` properties.</maml:para> <maml:para>And `Type` should be following value: - `Job` - `ProjectUpdate` - `InventoryUpdate` - `SystemJob` - `AdHocCommand` - `WorkflowJob`</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>The results of requested to cancel or determine whether cancelable.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Stop-AnsibleUnifiedJob -Type Job -Id 110 Id Type Status -- ---- ------ 110 Job Accepted PS C:\> Get-AnsibleJob -Id 110 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 110 Job Demo Job Template Run Manual Canceled ... ... ... ... ...</dev:code> <dev:remarks> <maml:para>Cancel Job ID 110.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Stop-AnsibleUnifiedJob -Type Job -Id 110 Stop-AnsibleUnifiedJob: 405 (Method Not Allowed): {"detail":"Method \"POST\" not allowed."} on POST /api/v2/jobs/110/cancel/ Id Type Status -- ---- ------ 110 Job MethodNotAllowed</dev:code> <dev:remarks> <maml:para>An error sample, when trying to cancel the job ID 110 that has already been completed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Stop-AnsibleUnifiedJob -Type Job -Id 110 -Determine Id Type CanCancel -- ---- --------- 110 Job False</dev:code> <dev:remarks> <maml:para>Check whether the Job ID 100 is canelable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AnsibleJobTemplateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleProjectUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleInventoryUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Switch-AnsibleApiConfig</command:name> <command:verb>Switch</command:verb> <command:noun>AnsibleApiConfig</command:noun> <maml:description> <maml:para>Switch to anothor config.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Load another configuration file to switching AWX/AnsibleTower URL or AccessToken. Default path is used when `-Path` parameter is ommitted or the value is empty.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Switch-AnsibleApiConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Configuration file path. Default configuration path is used if the path is empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Configuration file path. Default configuration path is used if the path is empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.ApiConfig</maml:name> </dev:type> <maml:description> <maml:para>Loaded configuration object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Switch-AnsibleApiConfig ~\.another_config.json Origin LastSaved File ------ --------- ---- http://localhost:8013/ 2024/06/15 9:49:08 C:\Users\***\.another_config.json</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-AnsibleApiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AnsibleApiConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-AnsibleCredential</command:name> <command:verb>Unregister</command:verb> <command:noun>AnsibleCredential</command:noun> <maml:description> <maml:para>Remove a Credential.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unregister a Credential from the specified resource.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/organizations/{id}/galaxy_credentials/` (POST) - `/api/v2/inventory_sources/{id}/credentials/` (POST) - `/api/v2/job_templates/{id}/credentials/` (POST) - `/api/v2/schedules/{id}/credentials/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/credentials/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-AnsibleCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Credential ID to be unregistered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Target resource to be unregistered from.</maml:para> <maml:para>Following resource is available: - `Organization` - `InventorySource` - `JobTemplate` - `Schedule` - `WorkflowJobTemplateNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Target resource to be unregistered from.</maml:para> <maml:para>Following resource is available: - `Organization` - `InventorySource` - `JobTemplate` - `Schedule` - `WorkflowJobTemplateNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Credential ID to be unregistered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Credential ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Unregister-AnsibleCredential -Id 2</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-AnsibleGroup</command:name> <command:verb>Unregister</command:verb> <command:noun>AnsibleGroup</command:noun> <maml:description> <maml:para>Unregister a Group from parent Group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unregister a Group from the parent Group.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/groups/{id}/children/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-AnsibleGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Group Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Parent Group ID.</maml:para> <maml:para>> [!NOTE] > Can specify `IResource` object. > For example: `-From (Get-AnsibleGroup -Id 10)`, `-From @{ type="group"; id = 10 }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Parent Group ID.</maml:para> <maml:para>> [!NOTE] > Can specify `IResource` object. > For example: `-From (Get-AnsibleGroup -Id 10)`, `-From @{ type="group"; id = 10 }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Group Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Group Id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Unregister-AnsibleGroup -Id 3 -From 1</dev:code> <dev:remarks> <maml:para>Disassociate the Group of ID 3 from the parent Group ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-AnsibleHost</command:name> <command:verb>Unregister</command:verb> <command:noun>AnsibleHost</command:noun> <maml:description> <maml:para>Remove a Host</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a Host or disassociate from the group.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/groups/{id}/hosts/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-AnsibleHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Parent Group ID.</maml:para> <maml:para>> [!NOTE] > Can specify `IResource` object. > For example: `-From (Get-AnsibleGroup -Id 10)`, `-From @{ type="group"; id = 10 }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Parent Group ID.</maml:para> <maml:para>> [!NOTE] > Can specify `IResource` object. > For example: `-From (Get-AnsibleGroup -Id 10)`, `-From @{ type="group"; id = 10 }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Unregister-AnsibleHost -Id 3 -From 1</dev:code> <dev:remarks> <maml:para>Disassociate the Host of ID 3 from the Group ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-AnsibleLabel</command:name> <command:verb>Unregister</command:verb> <command:noun>AnsibleLabel</command:noun> <maml:description> <maml:para>Unregister a Label from other resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unregister a Label from the target resource.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventories/{id}/labels/` (POST) - `/api/v2/job_templates/{id}/labels/` (POST) - `/api/v2/schedules/{id}/labels/` (POST) - `/api/v2/workflow_job_templates/{id}/labels/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/labels/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-AnsibleLabel</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Label ID to be unregistered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Target resource to be unregistered from.</maml:para> <maml:para>Following resource is available: - `Inventory` - `JobTemplate` - `Schedule` - `WorkflowJobTemplate` - `WorkflowJobTemplateNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>Target resource to be unregistered from.</maml:para> <maml:para>Following resource is available: - `Inventory` - `JobTemplate` - `Schedule` - `WorkflowJobTemplate` - `WorkflowJobTemplateNode`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Label ID to be unregistered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Label ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Unregister-AnsibleLabel -From (Get-AnsibleInventory -Id 2) -Id 1</dev:code> <dev:remarks> <maml:para>Disassociate the Label of ID 1 from the Inventory of Id 2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-AnsibleUser</command:name> <command:verb>Unregister</command:verb> <command:noun>AnsibleUser</command:noun> <maml:description> <maml:para>Unregister a User from other resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unregister a Label from the target resource.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/organization/{id}/users/` (POST) - `/api/v2/teams/{id}/users/` (POST) - `/api/v2/roles/{id}/users/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-AnsibleUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>User ID to be unregistered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>{{ Fill From Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>{{ Fill From Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>User ID to be unregistered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>User ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-AnsibleUser -Id 2 -From (Get-AnsibleOrganization -Id 1)</dev:code> <dev:remarks> <maml:para>Disassociate the User of ID 2 from the Organization of ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-AnsibleWorkflowJobTemplateNode</command:name> <command:verb>Unregister</command:verb> <command:noun>AnsibleWorkflowJobTemplateNode</command:noun> <maml:description> <maml:para>Unlink WorkflowJobTemplateNode from the parent.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unlink WorkflowJobTemplateNode from the parent.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_job_template_nodes/{id}/success_nodes/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/failure_nodes/` (POST) - `/api/v2/workflow_job_template_nodes/{id}/always_nodes/` (POST)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be child.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be parent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>From</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be parent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be child.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplateNode ID to be child.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Unregister-AnsibleWorkflowJobTemplateNode -Id 2 -From 1</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleApplication</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleApplication</command:noun> <maml:description> <maml:para>Update an Application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an Application. </maml:para> <maml:para>Implements following Rest API: - `/api/v2/applications/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Application ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>Set to `Public` or `Confidential` depending on how secure the client device is.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Confidential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ApplicationClientType</command:parameterValue> <dev:type> <maml:name>ApplicationClientType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RedirectUris</maml:name> <maml:description> <maml:para>Allowed URIs list, space separated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipAuthorization</maml:name> <maml:description> <maml:para>Set to skip authorization step for completely trusted application.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>Set to `Public` or `Confidential` depending on how secure the client device is.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApplicationClientType</command:parameterValue> <dev:type> <maml:name>ApplicationClientType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Application ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RedirectUris</maml:name> <maml:description> <maml:para>Allowed URIs list, space separated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipAuthorization</maml:name> <maml:description> <maml:para>Set to skip authorization step for completely trusted application.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Application</maml:name> </dev:type> <maml:description> <maml:para>Updated Application object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleApplication -Id 3 -Name "ChangedName"</dev:code> <dev:remarks> <maml:para>Change the name for the Application of Id 3.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleCredential</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleCredential</command:noun> <maml:description> <maml:para>Update a Credential.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Credential. </maml:para> <maml:para>Implements following Rest API: - `/api/v2/credentials/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Credential ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>CredentialType ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CredentialType</maml:name> <maml:description> <maml:para>CredentialType ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Credential ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Credential ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Credential</maml:name> </dev:type> <maml:description> <maml:para>Updated Credential object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleCredential -Id 2 -Description "Updated Description"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleCredentialType</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleCredentialType</command:noun> <maml:description> <maml:para>Update a CredentialType.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a CredentialType. </maml:para> <maml:para>Implements following Rest API: - `/api/v2/credential_types/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleCredentialType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>CredentialType ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Injectors</maml:name> <maml:description> <maml:para>Custom Credential Type Injectors object which raw Dictionary or `Jagabata.CredentialType.Injectors`.</maml:para> <maml:para>See: https://github.com/teramako/Jagabata.psm/blob/develop/docs/en-US/CredentialType.md</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para>Custom Credential Type Inputs object which raw Dictionary or `Jagabata.CredentialType.FieldList`.</maml:para> <maml:para>See: https://github.com/teramako/Jagabata.psm/blob/develop/docs/en-US/CredentialType.md</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">net</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">cloud</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>CredentialType ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Injectors</maml:name> <maml:description> <maml:para>Custom Credential Type Injectors object which raw Dictionary or `Jagabata.CredentialType.Injectors`.</maml:para> <maml:para>See: https://github.com/teramako/Jagabata.psm/blob/develop/docs/en-US/CredentialType.md</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para>Custom Credential Type Inputs object which raw Dictionary or `Jagabata.CredentialType.FieldList`.</maml:para> <maml:para>See: https://github.com/teramako/Jagabata.psm/blob/develop/docs/en-US/CredentialType.md</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Kind</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the CredentialType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>CredentialType ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.CredentialType</maml:name> </dev:type> <maml:description> <maml:para>Updated CredentialType object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleCredentialType -Id 30 -Name renamedCredType</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleCredentialType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleExecutionEnvironment</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleExecutionEnvironment</command:noun> <maml:description> <maml:para>Update an ExecutionEnvironment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an ExecutionEnvironment.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/execution_environments/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleExecutionEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID for container registry (kind = `registry`). Specify a `$null` or `0` value to clear the set value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Image</maml:name> <maml:description> <maml:para>The full image location, including the container registry, image name, and version tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID used to determine access to the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Pull</maml:name> <maml:description> <maml:para>Pull image before running: - ``: Unspecified.</maml:para> <maml:para>- `always`: Always pull container before running. - `missing`: Only pull the image if not present before running. - `never`: Never pull container before running.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false"></command:parameterValue> <command:parameterValue required="false" command:variableLength="false">always</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">missing</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">never</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID for container registry (kind = `registry`). Specify a `$null` or `0` value to clear the set value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Image</maml:name> <maml:description> <maml:para>The full image location, including the container registry, image name, and version tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID used to determine access to the ExecutionEnvironment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Pull</maml:name> <maml:description> <maml:para>Pull image before running: - ``: Unspecified.</maml:para> <maml:para>- `always`: Always pull container before running. - `missing`: Only pull the image if not present before running. - `never`: Never pull container before running.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ExecutionEnvironment</maml:name> </dev:type> <maml:description> <maml:para>Update ExecutionEnvironment object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleExecutionEnvironment -Id 4 -Pull missing</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleExecutionEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleGroup</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleGroup</command:noun> <maml:description> <maml:para>Update a Group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Group.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/groups/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ ansible_connection = "ssh"; ansible_user = "ssh_user" }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ ansible_connection = "ssh"; ansible_user = "ssh_user" }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Group Id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Group</maml:name> </dev:type> <maml:description> <maml:para>Updated Group object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleHost -Id 3 -Variables @{ ansible_user = "new_user" }</dev:code> <dev:remarks> <maml:para>Update variable for the Group of ID 3.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleHost</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleHost</command:noun> <maml:description> <maml:para>Update a Host.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Host.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/hosts/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Host ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Is the host online and available for running jobs?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>Used by the remote inventory source to uniquely identify the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ ansible_host = "192.168.0.10"; ansible_connection = "ssh"; }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Is the host online and available for running jobs?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Host ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>Used by the remote inventory source to uniquely identify the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ ansible_host = "192.168.0.10"; ansible_connection = "ssh"; }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Host Id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Host</maml:name> </dev:type> <maml:description> <maml:para>Updated Host object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleHost -Id 3 -Enabled $true -Variables @{ ansible_host = "192.168.0.100" }</dev:code> <dev:remarks> <maml:para>Update variable and activate for the Host of ID 3.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleInventory</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleInventory</command:noun> <maml:description> <maml:para>Update an Inventory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an Inventory.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventories/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Inventory ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostFilter</maml:name> <maml:description> <maml:para>Filter that will be applied to the hosts of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventInstanceGroupFallback</maml:name> <maml:description> <maml:para>If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on. If this setting is enabled and you provided an empty list, the global instance groups will be applied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ key1 = "value 1"; key2 = 10; }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostFilter</maml:name> <maml:description> <maml:para>Filter that will be applied to the hosts of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Inventory ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Inventory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventInstanceGroupFallback</maml:name> <maml:description> <maml:para>If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on. If this setting is enabled and you provided an empty list, the global instance groups will be applied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-Variables @{ key1 = "value 1"; key2 = 10; }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Inventory Id.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Inventory</maml:name> </dev:type> <maml:description> <maml:para>Updated Inventory object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleHost -Id 2 -Variables @{ key1 = "value 2" }</dev:code> <dev:remarks> <maml:para>Update variable for the Inventory of ID 2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleInventorySource</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleInventorySource</command:noun> <maml:description> <maml:para>Update an InventorySource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an InventorySource.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/inventory_sources/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleInventorySource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Cloud credential ID to use for inventory updates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledValue</maml:name> <maml:description> <maml:para>Only used when enabled_var is set. Value when the host is considered enabled. For example if `enabled_var="status.power_state" and enabled_value="powered_on"` with host variables: `{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}` The host would be marked enabled. If `power_state` where any value other than `powered_on` then the host would be disabled when imported. If the key is not found then the host will be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledVar</maml:name> <maml:description> <maml:para>Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: `from_dict.get("foo", {}).get("bar", default)`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironemnt ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostFilter</maml:name> <maml:description> <maml:para>This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Enter host, group or pattern match.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite local groups and hosts from remote InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OverwriteVars</maml:name> <maml:description> <maml:para>Overwrite local variables from remote InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>InventorySource SCM branch. Project default used if blank. Only allowed if project `allow_override` field is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Source Type:</maml:para> <maml:para>- `File`: File, Directory or Script - `Constructed`: Template additional groups and hostvars at runtime - `Scm`: Sourced from a Project - `EC2`: Amazon EC2 - `GCE`: Google Compute Engine - `AzureRM`: Microsoft Azure Resource Manager - `VMware`: VMware vCenter - `Satellite6`: Red Hat Satellite 6 - `OpenStack`: OpenStack - `RHV`: Red Hat Virtualization - `Controller`: Red Hat Ansible Automation Platform - `Insights`: Red Hat Insights</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Constructed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scm</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EC2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GCE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureRM</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VMware</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Satellite6</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OpenStack</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RHV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Controller</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Insights</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InventorySourceSource</command:parameterValue> <dev:type> <maml:name>InventorySourceSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourcePath</maml:name> <maml:description> <maml:para>Inventory directory, file, or script to load.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceProject</maml:name> <maml:description> <maml:para>Project containing inventory file used as source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceVars</maml:name> <maml:description> <maml:para>InventorySource variables in YAML or JSON format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateCacheTimeout</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateOnLaunch</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>- `0`: Warning - `1`: Info (Default) - `2`: Debug</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Cloud credential ID to use for inventory updates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledValue</maml:name> <maml:description> <maml:para>Only used when enabled_var is set. Value when the host is considered enabled. For example if `enabled_var="status.power_state" and enabled_value="powered_on"` with host variables: `{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}` The host would be marked enabled. If `power_state` where any value other than `powered_on` then the host would be disabled when imported. If the key is not found then the host will be enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnabledVar</maml:name> <maml:description> <maml:para>Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: `from_dict.get("foo", {}).get("bar", default)`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironemnt ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostFilter</maml:name> <maml:description> <maml:para>This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>InventorySource ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Enter host, group or pattern match.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite local groups and hosts from remote InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OverwriteVars</maml:name> <maml:description> <maml:para>Overwrite local variables from remote InventorySource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>InventorySource SCM branch. Project default used if blank. Only allowed if project `allow_override` field is set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>Source Type:</maml:para> <maml:para>- `File`: File, Directory or Script - `Constructed`: Template additional groups and hostvars at runtime - `Scm`: Sourced from a Project - `EC2`: Amazon EC2 - `GCE`: Google Compute Engine - `AzureRM`: Microsoft Azure Resource Manager - `VMware`: VMware vCenter - `Satellite6`: Red Hat Satellite 6 - `OpenStack`: OpenStack - `RHV`: Red Hat Virtualization - `Controller`: Red Hat Ansible Automation Platform - `Insights`: Red Hat Insights</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InventorySourceSource</command:parameterValue> <dev:type> <maml:name>InventorySourceSource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourcePath</maml:name> <maml:description> <maml:para>Inventory directory, file, or script to load.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceProject</maml:name> <maml:description> <maml:para>Project containing inventory file used as source.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceVars</maml:name> <maml:description> <maml:para>InventorySource variables in YAML or JSON format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateCacheTimeout</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UpdateOnLaunch</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>- `0`: Warning - `1`: Info (Default) - `2`: Debug</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>InventorySource ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InventorySource</maml:name> </dev:type> <maml:description> <maml:para>Updated InventorySource object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleInventorySource -Id 4 -SourcePath inventory/hosts_2.ini</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleInventorySource</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleJobTemplate</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleJobTemplate</command:noun> <maml:description> <maml:para>Update a JobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a JobTemplate.</maml:para> <maml:para>Implementation of following API: - `/api/v2/job_templates/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowSimultaneous</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskCredential</maml:name> <maml:description> <maml:para>Ask credential on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskDiffMode</maml:name> <maml:description> <maml:para>Ask diff-mode on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskExecutionEnvironment</maml:name> <maml:description> <maml:para>Ask execution environment on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskForks</maml:name> <maml:description> <maml:para>Ask number of forks on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskInventory</maml:name> <maml:description> <maml:para>Ask inventory on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskJobSliceCount</maml:name> <maml:description> <maml:para>Ask job slice count on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskJobType</maml:name> <maml:description> <maml:para>Ask job-type on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLabels</maml:name> <maml:description> <maml:para>Ask labels on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLimit</maml:name> <maml:description> <maml:para>Ask limit on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskScmBranch</maml:name> <maml:description> <maml:para>Ask scm-branch on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskSkipTags</maml:name> <maml:description> <maml:para>Ask skip tags on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskTags</maml:name> <maml:description> <maml:para>Ask job tags on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVariables</maml:name> <maml:description> <maml:para>Ask extra variables on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVerbosity</maml:name> <maml:description> <maml:para>Ask verbosity on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BecomeEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the JobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForceHandlers</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostConfigKey</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the JobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Playbook</maml:name> <maml:description> <maml:para>File path of the playbook in the specified Project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventInstanceGroupFallback</maml:name> <maml:description> <maml:para>If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on. If this setting is enabled and you provided an empty list, the global instance groups will be applied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartAtTask</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SurveyEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseFactCache</maml:name> <maml:description> <maml:para>If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookCredential</maml:name> <maml:description> <maml:para>Credential ID of Personal Access Token (`github` or `gitlab`) for posting back the status to the service api.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookService</maml:name> <maml:description> <maml:para>Service that webhook requests will be accepted from `github` or `gitlab`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">github</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">gitlab</command:parameterValue> <command:parameterValue required="false" command:variableLength="false"></command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowSimultaneous</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskCredential</maml:name> <maml:description> <maml:para>Ask credential on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskDiffMode</maml:name> <maml:description> <maml:para>Ask diff-mode on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskExecutionEnvironment</maml:name> <maml:description> <maml:para>Ask execution environment on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskForks</maml:name> <maml:description> <maml:para>Ask number of forks on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskInventory</maml:name> <maml:description> <maml:para>Ask inventory on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskJobSliceCount</maml:name> <maml:description> <maml:para>Ask job slice count on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskJobType</maml:name> <maml:description> <maml:para>Ask job-type on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLabels</maml:name> <maml:description> <maml:para>Ask labels on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLimit</maml:name> <maml:description> <maml:para>Ask limit on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskScmBranch</maml:name> <maml:description> <maml:para>Ask scm-branch on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskSkipTags</maml:name> <maml:description> <maml:para>Ask skip tags on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskTags</maml:name> <maml:description> <maml:para>Ask job tags on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVariables</maml:name> <maml:description> <maml:para>Ask extra variables on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVerbosity</maml:name> <maml:description> <maml:para>Ask verbosity on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BecomeEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the JobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForceHandlers</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostConfigKey</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>JobTemplate ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("Run" or "Check")</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the JobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Playbook</maml:name> <maml:description> <maml:para>File path of the playbook in the specified Project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreventInstanceGroupFallback</maml:name> <maml:description> <maml:para>If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on. If this setting is enabled and you provided an empty list, the global instance groups will be applied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run. Project default is used if omitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartAtTask</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SurveyEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseFactCache</maml:name> <maml:description> <maml:para>If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookCredential</maml:name> <maml:description> <maml:para>Credential ID of Personal Access Token (`github` or `gitlab`) for posting back the status to the service api.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookService</maml:name> <maml:description> <maml:para>Service that webhook requests will be accepted from `github` or `gitlab`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>JobTemplate ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobTemplate</maml:name> </dev:type> <maml:description> <maml:para>Updated JobTemplate object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleJobTemplate -Id 10 -JobType Check -AskJobType $true</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleJobtemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleLabel</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleLabel</command:noun> <maml:description> <maml:para>Update a Label.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Label</maml:para> <maml:para>Implements following Rest API: - `/api/v2/labels/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleLabel</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Target Label ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Label name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Target Label ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Label name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Target Label ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Label</maml:name> </dev:type> <maml:description> <maml:para>Updated Label object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleLabel -Id 1 -Name FixedName Id Type Name Modified Organization -- ---- ---- -------- ------------ 1 Label FixedName 09/10/2024 21:50:24 [2]TestOrg</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleLabel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleNotificationTemplate</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleNotificationTemplate</command:noun> <maml:description> <maml:para>Update a NotificationTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a NotificationTemplate.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/notification_templates/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleNotificationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>NotificationTemplate ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Value corresponding to NotificationType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the NotificationTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Messages</maml:name> <maml:description> <maml:para>Optional custom messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the NotificationTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of Notification</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Email</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Grafana</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IRC</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Mattemost</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pagerduty</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoketChat</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Slack</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Twillo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Webhook</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">NotificationType</command:parameterValue> <dev:type> <maml:name>NotificationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Value corresponding to NotificationType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the NotificationTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>NotificationTemplate ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Messages</maml:name> <maml:description> <maml:para>Optional custom messages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the NotificationTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of Notification</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NotificationType</command:parameterValue> <dev:type> <maml:name>NotificationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>NotificationTemplate ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.NotificationTemplate</maml:name> </dev:type> <maml:description> <maml:para>Updated NotificationTemplate object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleNotificationTemplate -Id 2 -Name "Renamed"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleNotificationTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleOrganization</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleOrganization</command:noun> <maml:description> <maml:para>Update an Organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an Organization. </maml:para> <maml:para>Implements following Rest API: - `/api/v2/organizations/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleOrganization</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Organization ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> <maml:para>> [!TIP] > Specify `0` or `$null` if want to set empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxHosts</maml:name> <maml:description> <maml:para>Maximum number of hosts allowed to be managed by the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> <maml:para>> [!TIP] > Specify `0` or `$null` if want to set empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Organization ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxHosts</maml:name> <maml:description> <maml:para>Maximum number of hosts allowed to be managed by the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Organization</maml:name> </dev:type> <maml:description> <maml:para>Updated Organization object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleOrganization -Id 2 -Name "ChangedName"</dev:code> <dev:remarks> <maml:para>Change the name for the Organization of Id 2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleOrganization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleProject</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleProject</command:noun> <maml:description> <maml:para>Update a Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Project. </maml:para> <maml:para>Implements following Rest API: - `/api/v2/projects/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowOverride</maml:name> <maml:description> <maml:para>Allow changing the SCM branch or revision in a job template that uses the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID. Must be `scm` kind credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>The default Execution Environment for jobs run using the project.</maml:para> <maml:para>> [!TIP] > Specify `0` or `$null` if want to set empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Local path (relative to `PROJECT_ROOT`) containing playbooks and related files for the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specific branch, tag or commit to checkout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmClean</maml:name> <maml:description> <maml:para>Discard any local changes before syncing the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmDeleteOnUpdate</maml:name> <maml:description> <maml:para>Delete the project before syncing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmRefspec</maml:name> <maml:description> <maml:para>Fit git projects, an additional refspec to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmTrackSubmodules</maml:name> <maml:description> <maml:para>Track submodules latest commits on defined branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmType</maml:name> <maml:description> <maml:para>Specifies the source control system used to store the project.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false"></command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Manual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Subversion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Insights</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RemoteArchive</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUpdateOnLaunch</maml:name> <maml:description> <maml:para>Update the project when a job is launched that uses the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUrl</maml:name> <maml:description> <maml:para>The location where the project is stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignatureValidationCredential</maml:name> <maml:description> <maml:para>An optional credential used for validating files in the project against unexpected changes.</maml:para> <maml:para>> [!TIP] > Specify `0` or `$null` if want to set empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowOverride</maml:name> <maml:description> <maml:para>Allow changing the SCM branch or revision in a job template that uses the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential ID. Must be `scm` kind credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>The default Execution Environment for jobs run using the project.</maml:para> <maml:para>> [!TIP] > Specify `0` or `$null` if want to set empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Project ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Local path (relative to `PROJECT_ROOT`) containing playbooks and related files for the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specific branch, tag or commit to checkout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmClean</maml:name> <maml:description> <maml:para>Discard any local changes before syncing the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmDeleteOnUpdate</maml:name> <maml:description> <maml:para>Delete the project before syncing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmRefspec</maml:name> <maml:description> <maml:para>Fit git projects, an additional refspec to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmTrackSubmodules</maml:name> <maml:description> <maml:para>Track submodules latest commits on defined branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmType</maml:name> <maml:description> <maml:para>Specifies the source control system used to store the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUpdateOnLaunch</maml:name> <maml:description> <maml:para>Update the project when a job is launched that uses the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmUrl</maml:name> <maml:description> <maml:para>The location where the project is stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignatureValidationCredential</maml:name> <maml:description> <maml:para>An optional credential used for validating files in the project against unexpected changes.</maml:para> <maml:para>> [!TIP] > Specify `0` or `$null` if want to set empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The amount of time (in seconds) to run before the task is canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Project ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Project</maml:name> </dev:type> <maml:description> <maml:para>Updated Project object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleProject -Id 10 -ScmBranch develop -AllowOverride $true</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleProject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleSchedule</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleSchedule</command:noun> <maml:description> <maml:para>Update a Schedule.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Schedule.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/schedules/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleSchedule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Schedule ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Turn Diff mode on or off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Turn the Schedule enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraData</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>JobType ("Run" or "Check")</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Check</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RRule</maml:name> <maml:description> <maml:para>Scheduling data which has Recurrence Rule a.k.a `RRULE` and starting datetime a.k.a `DTSTART`.</maml:para> <maml:para>See: RFC5545 - 3.3.10. Recurrence Rule (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10)> [!TIP] > Scheduling data can be made from `Jagabata.Schedule.Calendar` and `Jagabata.Schedule.RRule`. > ></maml:para> <maml:para></maml:para> <maml:para>> $calendar = [Jagabata.Schedule.Calendar]::new([datetime]"2025-03-10 21:30") # DTSTART</maml:para> <maml:para>> $rule1 = ([Jagabata.Schedule.RRule]@{ Freq = "Yearly"; }).SetMonth(4).SetMonthDay(1) # April 1 of each year</maml:para> <maml:para>> $rule2 = ([Jagabata.Schedule.RRule]@{ Freq = "Monthly"; Interval = 3 }).SetWeekDay("SA").SetPos(1) # First Saturday of every three months</maml:para> <maml:para>> $calendar.RRules.Add($rule1)</maml:para> <maml:para>> $calendar.RRules.Add($rule2) </maml:para> <maml:para>></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job Tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Turn Diff mode on or off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Turn the Schedule enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraData</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Schedule ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>JobType ("Run" or "Check")</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobType</command:parameterValue> <dev:type> <maml:name>JobType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RRule</maml:name> <maml:description> <maml:para>Scheduling data which has Recurrence Rule a.k.a `RRULE` and starting datetime a.k.a `DTSTART`.</maml:para> <maml:para>See: RFC5545 - 3.3.10. Recurrence Rule (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10)> [!TIP] > Scheduling data can be made from `Jagabata.Schedule.Calendar` and `Jagabata.Schedule.RRule`. > ></maml:para> <maml:para></maml:para> <maml:para>> $calendar = [Jagabata.Schedule.Calendar]::new([datetime]"2025-03-10 21:30") # DTSTART</maml:para> <maml:para>> $rule1 = ([Jagabata.Schedule.RRule]@{ Freq = "Yearly"; }).SetMonth(4).SetMonthDay(1) # April 1 of each year</maml:para> <maml:para>> $rule2 = ([Jagabata.Schedule.RRule]@{ Freq = "Monthly"; Interval = 3 }).SetWeekDay("SA").SetPos(1) # First Saturday of every three months</maml:para> <maml:para>> $calendar.RRules.Add($rule1)</maml:para> <maml:para>> $calendar.RRules.Add($rule2) </maml:para> <maml:para>></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job Tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Schedule</maml:name> </dev:type> <maml:description> <maml:para>Updated Schedule object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleSchedule -Id 10 -Enable $true</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $calendar = [Jagabata.Schedule.Calendar]::new([datetime]"2025-03-10 21:30") PS C:\> $rule1 = ([Jagabata.Schedule.RRule]@{ Freq = "Yearly"; }).SetMonth(4).SetMonthDay(1) PS C:\> $calendar.RRules.Add($rule1) PS C:\> $calendar.ToString(); DTSTART;TZID=Asia/Tokyo:20250310T213000 RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTHDAY=1;BYMONTH=4 PS C:\> Update-AnsibleSchedule -Id 10 -RRrule $calendar</dev:code> <dev:remarks> <maml:para>Update scheduling for ID 10.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-AnsibleSchedule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleTeam</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleTeam</command:noun> <maml:description> <maml:para>Update a Team.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a Team. </maml:para> <maml:para>Implements following Rest API: - `/api/v2/teams/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleTeam</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Team ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Team.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Team name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the Team.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Team ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Team name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>Team ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.Team</maml:name> </dev:type> <maml:description> <maml:para>Updated Team object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleTeam -Id 2 -Name "NewName" Id Type Name Description Created Modified OrganizationName -- ---- ---- ----------- ------- -------- ---------------- 2 Team NewName デモ 1 09/11/2024 15:27:45 09/11/2024 15:28:19 TestOrg</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleTeam</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleToken</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleToken</command:noun> <maml:description> <maml:para>Update an AccessToken.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an AccessToken. </maml:para> <maml:para>Implements following Rest API: - `/api/v2/tokens/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleToken</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>AccessToken ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the AccessToken.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Allowed scopes, further restricts user's permission.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">read</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">write</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the AccessToken.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>AccessToken ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Allowed scopes, further restricts user's permission.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>AccessToken ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.OAuth2AccessToken</maml:name> </dev:type> <maml:description> <maml:para>Updated AccessToken object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleToken -Id 3 -Scope read -Description "Read only token"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleToken</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleUser</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleUser</command:noun> <maml:description> <maml:para>Update a User.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a User.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/users/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>User ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FirstName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSuperUser</maml:name> <maml:description> <maml:para>Designates that the User has all permissions without explicitly assinging them.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSystemAuditor</maml:name> <maml:description> <maml:para>Designates that the User is the system auditor.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LastName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specify `SecureString` object. generated by commands such as `ConvertTo-SecureString` or `(Get-Credential).Password`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FirstName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>User ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSuperUser</maml:name> <maml:description> <maml:para>Designates that the User has all permissions without explicitly assinging them.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSystemAuditor</maml:name> <maml:description> <maml:para>Designates that the User is the system auditor.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LastName</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specify `SecureString` object. generated by commands such as `ConvertTo-SecureString` or `(Get-Credential).Password`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.User</maml:name> </dev:type> <maml:description> <maml:para>Updated User object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleUser -Id 3 -IsSystemAuditor $true -FirstName ""</dev:code> <dev:remarks> <maml:para>Update for the User of ID 3 to SystemAuditor and FirstName to empty.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleWorkflowJobTemplate</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleWorkflowJobTemplate</command:noun> <maml:description> <maml:para>Update a WorkflowJobTemplate.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a WorkflowJobTemplate.</maml:para> <maml:para>Implementation of following API: - `/api/v2/workflow_job_templates/{id}/` (PATCH)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleWorkflowJobTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowSimultaneous</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskInventory</maml:name> <maml:description> <maml:para>Ask inventory on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLabels</maml:name> <maml:description> <maml:para>Ask labels on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLimit</maml:name> <maml:description> <maml:para>Ask limit on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskScmBranch</maml:name> <maml:description> <maml:para>Ask scm-branch on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskSkipTags</maml:name> <maml:description> <maml:para>Ask skip tags on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskTags</maml:name> <maml:description> <maml:para>Ask job tags on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVariables</maml:name> <maml:description> <maml:para>Ask extra variables on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SurveyEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookCredential</maml:name> <maml:description> <maml:para>Credential ID of Personal Access Token (`github` or `gitlab`) for posting back the status to the service api.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookService</maml:name> <maml:description> <maml:para>Service that webhook requests will be accepted from `github` or `gitlab`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">github</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">gitlab</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowSimultaneous</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskInventory</maml:name> <maml:description> <maml:para>Ask inventory on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLabels</maml:name> <maml:description> <maml:para>Ask labels on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskLimit</maml:name> <maml:description> <maml:para>Ask limit on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskScmBranch</maml:name> <maml:description> <maml:para>Ask scm-branch on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskSkipTags</maml:name> <maml:description> <maml:para>Ask skip tags on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskTags</maml:name> <maml:description> <maml:para>Ask job tags on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AskVariables</maml:name> <maml:description> <maml:para>Ask extra variables on launch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraVars</maml:name> <maml:description> <maml:para>Specify extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflowJobTemplate ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the WorkflowJobTemplate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Specify branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SurveyEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookCredential</maml:name> <maml:description> <maml:para>Credential ID of Personal Access Token (`github` or `gitlab`) for posting back the status to the service api.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WebhookService</maml:name> <maml:description> <maml:para>Service that webhook requests will be accepted from `github` or `gitlab`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplate ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplate</maml:name> </dev:type> <maml:description> <maml:para>Updated WorkflowJobTemplate object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleWorkflowJobTemplate -Id 3 -AskVariables $true</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-AnsibleWorkflowJobTemplateNode</command:name> <command:verb>Update</command:verb> <command:noun>AnsibleWorkflowJobTemplateNode</command:noun> <maml:description> <maml:para>Update a WorkflowJobTemplateNode.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a WorkflowJobTemplateNode.</maml:para> <maml:para>Implements following Rest API: - `/api/v2/workflow_job_template_nodes/{id}/` (PATCH) </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AnsibleWorkflowJobTemplateNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflwJobTemplateNode ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllParentsMustConverge</maml:name> <maml:description> <maml:para>If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Diff mode</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraData</maml:name> <maml:description> <maml:para>Extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identifier</maml:name> <maml:description> <maml:para>An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("run" or "check")</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">run</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">check</command:parameterValue> <command:parameterValue required="false" command:variableLength="false"></command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Template"> <maml:name>UnifiedJobTemplate</maml:name> <maml:description> <maml:para>UnifiedJobTemplate (JobTemplate, Project, InventorySource, WorkflowJobTemplate) ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MoreVerbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionDebug</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WinRMDebug</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllParentsMustConverge</maml:name> <maml:description> <maml:para>If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DiffMode</maml:name> <maml:description> <maml:para>Diff mode</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExecutionEnvironment</maml:name> <maml:description> <maml:para>ExecutionEnvironment ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExtraData</maml:name> <maml:description> <maml:para>Extra variables.</maml:para> <maml:para>Specify in JSON or YAML format. You can also specify an object of type `IDictionary` as a parameter value.</maml:para> <maml:para>Example: `-ExtraVars @{ key1 = "string"; key2 = 10; key3 = Get-Date }`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Forks</maml:name> <maml:description> <maml:para>Number of forks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>WorkflwJobTemplateNode ID to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identifier</maml:name> <maml:description> <maml:para>An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Inventory</maml:name> <maml:description> <maml:para>Inventory ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobSliceCount</maml:name> <maml:description> <maml:para>Number of job slice count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>JobType</maml:name> <maml:description> <maml:para>Specify JobType ("run" or "check")</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Further limit selected hosts to an additional pattern.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScmBranch</maml:name> <maml:description> <maml:para>Branch to use in job run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipTags</maml:name> <maml:description> <maml:para>Skip tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Job tags. (commas `,` separated)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value (seconds).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Template"> <maml:name>UnifiedJobTemplate</maml:name> <maml:description> <maml:para>UnifiedJobTemplate (JobTemplate, Project, InventorySource, WorkflowJobTemplate) ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>Job verbosity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobVerbosity</command:parameterValue> <dev:type> <maml:name>JobVerbosity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> </dev:type> <maml:description> <maml:para>WorkflowJobTemplateNode ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJobTemplateNode</maml:name> </dev:type> <maml:description> <maml:para>Updated WorkflowJobTemplateNode object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Update-AnsibleWorkflowJobTemplateNode -Id 30 -ExtraData @{ message = "Hello World" }</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AnsibleWorkflowJobTemplateNode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Wait-AnsibleUnifiedJob</command:name> <command:verb>Wait</command:verb> <command:noun>AnsibleUnifiedJob</command:noun> <maml:description> <maml:para>Wait until jobs are finished.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Wait until a job is finished. While waiting, retrieve the logs periodically and ouput.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Wait-AnsibleUnifiedJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Job</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProjectUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InventoryUpdate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SystemJob</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AdHocCommand</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WorkflowJob</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Job ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Wait-AnsibleUnifiedJob ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [111] Test_1 ====== > > (snip) </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Wait-AnsibleUnifiedJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Wait-AnsibleUnifiedJob ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [111] Test_1 ====== > > (snip) </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Wait-AnsibleUnifiedJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>UnifiedJob resource object from which to wait.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `WorkflowJob` : WorkflowJobTemplate's job - `SystemJob` : SystemJobTemplate's job</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Wait-AnsibleUnifiedJob ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [111] Test_1 ====== > > (snip) </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Job ID of the target resource. Use in conjection with the `-Type` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IntervalSeconds</maml:name> <maml:description> <maml:para>Interval to confirm job completion (seconds). Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>UnifiedJob resource object from which to wait.</maml:para> <maml:para>The resource is an object with `Id` and `Type` properties. And `Type` should be following value: - `Job` : JobTempalte's job - `ProjectUpdate` : Project's update job - `InventoryUpdate` : InventorySource's update job - `AdHocCommand` : AdHocCommand's job - `WorkflowJob` : WorkflowJobTemplate's job - `SystemJob` : SystemJobTemplate's job</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IResource</command:parameterValue> <dev:type> <maml:name>IResource</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressJobLog</maml:name> <maml:description> <maml:para>Suppress display job log.</maml:para> <maml:para>> [!TIP] > If you need the job log, use `-InformationVariable` parameter likes following: > > PS C:> Wait-AnsibleUnifiedJob ... -SuppressJobLog -InformationVariable joblog > (snip) > PS C:> $joblog > ====== [111] Test_1 ====== > > (snip) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Resource type name of the target. Use in conjection with the `-Id` parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Jagabata.Resources.IResource</maml:name> </dev:type> <maml:description> <maml:para>The object has `Id` and `Type` properties.</maml:para> <maml:para>And `Type` should be following value: - `Job` - `ProjectUpdate` - `InventoryUpdate` - `SystemJob` - `AdHocCommand` - `WorkflowJob`</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.JobTemplateJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.ProjectUpdateJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.InventoryUpdateJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.SystemJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.AdHocCommand</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Jagabata.Resources.WorkflowJob</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Wait-AnsibleUnifiedJob -Type Job -Id 110 ====== [110] Demo Job Template ====== PLAY [Hello World Sample] ****************************************************** TASK [Gathering Facts] ********************************************************* ok: [localhost] TASK [Hello Message] *********************************************************** ok: [localhost] => { "msg": "Hello World!" } PLAY RECAP ********************************************************************* localhost : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 Id Type Name JobType LaunchType Status Finished Elapsed LaunchedBy Template Note -- ---- ---- ------- ---------- ------ -------- ------- ---------- -------- ---- 110 Job Demo Job Template Run Manual Successful .... ... ... ... ...</dev:code> <dev:remarks> <maml:para>Wait until Job ID 110 is completed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Find-AnsibleJob -Status running | Wait-AnsibleUnifiedJob</dev:code> <dev:remarks> <maml:para>Retrieve running jobs currently, and wait until those jobs are completed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AnsibleJobTemplateJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleProjectUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleInventoryUpdate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleSystemJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleAdHocCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AnsibleWorkflowJobTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-AnsibleUnifiedJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |