Skip to content
This repository has been archived by the owner on Oct 29, 2021. It is now read-only.

Commit

Permalink
Update help.
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdriscoll committed Jan 15, 2020
1 parent 2a71842 commit ed171fc
Show file tree
Hide file tree
Showing 15 changed files with 316 additions and 23 deletions.
2 changes: 1 addition & 1 deletion help/Get-UAAppToken.md
Expand Up @@ -36,7 +36,7 @@ Gets app tokens stored in the UA database.

### Example 1
```powershell
PS C:\> Get-UAAppToken
PS C:\> Get-UAAppToken
```

Returns all app tokens.
Expand Down
2 changes: 1 addition & 1 deletion help/Get-UAFolder.md
Expand Up @@ -39,7 +39,7 @@ Returns folders defined within UA. Folders will be based on the internal and\or

### Example 1
```powershell
PS C:\> Get-UAFolder
PS C:\> Get-UAFolder
```

Returns all folders within UA.
Expand Down
2 changes: 1 addition & 1 deletion help/Get-UAIdentity.md
Expand Up @@ -34,7 +34,7 @@ Returns identities defined within UA. Identities are apps or users accessing UA.

### Example 1
```powershell
PS C:\> Get-UAIdentity
PS C:\> Get-UAIdentity
```

Returns all the identities defined within UA.
Expand Down
101 changes: 93 additions & 8 deletions help/Get-UAJob.md
Expand Up @@ -14,22 +14,29 @@ Returns jobs run within UA.

### All (Default)
```
Get-UAJob [-Tree] [-ComputerName <String>] [-AppToken <String>] [<CommonParameters>]
Get-UAJob [-Status <JobStatus>] [-OrderBy <String>] [-OrderDirection <OrderDirection>] [-ComputerName <String>]
[-AppToken <String>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
```

### Id
```
Get-UAJob [-Id] <Int64> [-Tree] [-ComputerName <String>] [-AppToken <String>] [<CommonParameters>]
Get-UAJob [-Id] <Int64> [-Status <JobStatus>] [-OrderBy <String>] [-OrderDirection <OrderDirection>]
[-ComputerName <String>] [-AppToken <String>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
[<CommonParameters>]
```

### Identity
```
Get-UAJob [-Identity] <Identity> [-Tree] [-ComputerName <String>] [-AppToken <String>] [<CommonParameters>]
Get-UAJob [-Identity] <Identity> [-Status <JobStatus>] [-OrderBy <String>] [-OrderDirection <OrderDirection>]
[-ComputerName <String>] [-AppToken <String>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
[<CommonParameters>]
```

### Script
```
Get-UAJob [-Script] <Script> [-Tree] [-ComputerName <String>] [-AppToken <String>] [<CommonParameters>]
Get-UAJob [-Script] <Script> [-Status <JobStatus>] [-OrderBy <String>] [-OrderDirection <OrderDirection>]
[-ComputerName <String>] [-AppToken <String>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
[<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -39,7 +46,7 @@ Returns jobs run within UA.

### Example 1
```powershell
PS C:\> Get-UAJob
PS C:\> Get-UAJob
```

Returns all jobs run in UA.
Expand Down Expand Up @@ -98,6 +105,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -First
Gets only the specified number of objects. Enter the number of objects to get.

```yaml
Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Id
The ID of the job to return.

Expand Down Expand Up @@ -128,6 +150,53 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```

### -IncludeTotalCount
Reports the total number of objects in the data set (an integer) followed by the selected objects. If the cmdlet cannot determine the total count, it displays "Unknown total count." The integer has an Accuracy property that indicates the reliability of the total count value. The value of Accuracy ranges from 0.0 to 1.0 where 0.0 means that the cmdlet could not count the objects, 1.0 means that the count is exact, and a value between 0.0 and 1.0 indicates an increasingly reliable estimate.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OrderBy
Orders the output based on the property selected.

```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Id, StartTime, EndTime

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OrderDirection
Orders ascending or descending.

```yaml
Type: OrderDirection
Parameter Sets: (All)
Aliases:
Accepted values: Descending, Ascending

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Script
Returns jobs based on this script.

Expand All @@ -143,13 +212,29 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```

### -Tree
Returns all associated jobs of the specified script.
### -Skip
Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip.

```yaml
Type: SwitchParameter
Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Status
Filters output based on this status.

```yaml
Type: JobStatus
Parameter Sets: (All)
Aliases:
Accepted values: Queued, Running, Completed, Failed, WaitingOnFeedback, Canceled, Canceling, Historical, Active

Required: False
Position: Named
Expand Down
75 changes: 75 additions & 0 deletions help/Get-UALicense.md
@@ -0,0 +1,75 @@
---
external help file: UniversalAutomation.Cmdlets.dll-Help.xml
Module Name: UniversalAutomation
online version:
schema: 2.0.0
---

# Get-UALicense

## SYNOPSIS
Returns information about the installed license.

## SYNTAX

```
Get-UALicense [-ComputerName <String>] [-AppToken <String>] [<CommonParameters>]
```

## DESCRIPTION
Returns information about the installed license.

## EXAMPLES

### Example 1
```powershell
PS C:\> Get-UALicense
```

Returns license information.

## PARAMETERS

### -AppToken
An app token to access the UA API.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ComputerName
The HTTP address of the UA REST API server.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### System.Object
## NOTES

## RELATED LINKS
2 changes: 1 addition & 1 deletion help/Get-UAScript.md
Expand Up @@ -64,7 +64,7 @@ Returns the script with ID 12.
### Example 3
```powershell
PS C:\> $Identity = Get-UAIdentity -Name 'Adam'
PS C:\> Get-UAScript -Identity $Identity
PS C:\> Get-UAScript -Identity $Identity
```

Returns all scripts created or modified by the identity 'Adam'.
Expand Down
5 changes: 2 additions & 3 deletions help/Invoke-UAScript.md
Expand Up @@ -40,7 +40,7 @@ Invokes 'Script1.ps1'
### Example 2
```powershell
PS C:\> $Script = Get-UAScript -Name 'Script1.ps1'
PS C:\> Invoke-UAScript -Script $Script -Parameter1 123 -Parameter2 "Test"
PS C:\> Invoke-UAScript -Script $Script -Parameter1 123 -Parameter2 "Test"
```

Invokes 'Script1.ps1' with the parameters Parameter1 and Parameter2. These parameters will be passed to the script. Invoke-UAScript supports any number of dynamic parameters.
Expand All @@ -50,12 +50,11 @@ Invokes 'Script1.ps1' with the parameters Parameter1 and Parameter2. These param
PS C:\> $Script = Get-UAScript -Name 'Script1.ps1'
PS C:\> $Password = Get-UAVariable -Name 'UserPassword'
PS C:\> $Credential = New-UDCredential -UserName 'adam' -Password $Password
PS C:\> Invoke-UAScript -Script $Script -Credential $Credential
PS C:\> Invoke-UAScript -Script $Script -Credential $Credential
```

Invokes 'Script1.ps1' as the user 'adam'. Passwords are retrieved from secret managers and cannot be passed in as strings.


## PARAMETERS

### -AppToken
Expand Down
2 changes: 1 addition & 1 deletion help/New-UACredential.md
Expand Up @@ -25,7 +25,7 @@ Creates a new credential to be used for running scripts as the specified user. T
### Example 1
```powershell
PS C:\> $Variable = Get-UAVariable -Name 'password'
PS C:\> $Credential = New-UACredential -UserName 'adam' -Password $Variable
PS C:\> $Credential = New-UACredential -UserName 'adam' -Password $Variable
```

Retrieves the password variable and creates a new credential for the user 'adam'. The credential must be a secret coming from a secret manager.
Expand Down
1 change: 0 additions & 1 deletion help/New-UAScript.md
Expand Up @@ -54,7 +54,6 @@ PS C:\> New-UAScript -ScriptBlock { Get-Process } -Name 'GetProcess' -PowerShell

Creates the script "GetProcess" in UA. A script named 'GetProcess.ps1" will be created in the Git repoisitory. This script will be run using the PS7 PowerShell version.


## PARAMETERS

### -AppToken
Expand Down
2 changes: 1 addition & 1 deletion help/New-UASecretManager.md
Expand Up @@ -24,7 +24,7 @@ Creates a new secret manager in UA. Secret managers are used to retrieving secre

### Example 1
```powershell
PS C:\> New-UASecretManager -Name 'Vault' -Get { param($Name) Get-SecretFromVault -Name $Name }
PS C:\> New-UASecretManager -Name 'Vault' -Get { param($Name) Get-SecretFromVault -Name $Name }
```

Creates a new secret manager that retrieves a secret from the vault using a Get-SecretFromVault cmdlet. The Get scriptblock should accept the name of a variable and return a string.
Expand Down
2 changes: 1 addition & 1 deletion help/New-UATag.md
Expand Up @@ -24,7 +24,7 @@ Creates a new tag in UA. Tags are used for identifying scripts.

### Example 1
```powershell
PS C:\> New-UATag -Name 'Release Pipeline' -Color 'red'
PS C:\> New-UATag -Name 'Release Pipeline' -Color 'red'
```

Creates a new tag called Release Pipeline that will be red in the UI.
Expand Down
2 changes: 1 addition & 1 deletion help/Remove-UASchedule.md
Expand Up @@ -24,7 +24,7 @@ Removes a schedule for a script.
### Example 1
```powershell
PS C:\> $Schedule = Get-UASchedule -Id 12
PS C:\> Remove-UASchedule -Schedule $Schedule
PS C:\> Remove-UASchedule -Schedule $Schedule
```

Removes schedule 12.
Expand Down
2 changes: 1 addition & 1 deletion help/Remove-UAScriptTag.md
Expand Up @@ -26,7 +26,7 @@ Removes a tag from a script.
```powershell
PS C:\> $Tag = Get-UATag -Name 'Release'
PS C:\> $Script = Get-UAScript -Name 'Script1.ps1'
PS C:\> Remove-UAScriptTag -Tag $Tag -Script $Script
PS C:\> Remove-UAScriptTag -Tag $Tag -Script $Script
```

Removes the Release tag from the Script1.ps1 script.
Expand Down

0 comments on commit ed171fc

Please sign in to comment.