JAMS PowerShell Cmdlets
Microsoft designed PowerShell to provide more task automation and configuration management tools based on the .NET Framework. PowerShell includes a command line shell and an extensive scripting language that uses small programs called "cmdlets".
PowerShell's capabilities provide creative ways to simplify and automate tedious and repetitive tasks by creating scripts and combining them with multiple commands.
JAMS has fully incorporated PowerShell. The JAMS Client component includes a PowerShell Module that includes dozens of JAMS cmdlets, which are listed and detailed in the following section.
JAMS PowerShell Cmdlets
The JAMS PowerShell Module contains dozens of cmdlets that add extensive PowerShell capabilities to JAMS. The following table contains an extensive listing of each JAMS-related cmdlet, detailing the cmdlet’s description and syntax.
See Installing the PowerShell Module for information on loading the module.
| JAMS Cmdlets | Description |
|---|---|
| Connect-JEWS |
This cmdlet establishes a connection to an EWS server. When using Microsoft Office 365 Modern Authentication, use the JAMSConnection option to specify the EWS Connection Store object. The Connection should have the Client Id, Tenant Id, and Client Secret Value. You can use Get-JAMSCredential to get a valid Credential.
[AcceptAllCertificates] [-AllowSSL] [-AllowTLS] [-AllowTLS11] [-AllowTLS12] [-Authentication <String>] [-Credential]<String>] [-ImplicitMode] [-JAMSConnection <string>] [-MinimumKeySize <int32>] [-Port <Int32>] [<CommonParameters>] |
| Connect-JFTP |
This cmdlet establishes a connection to an FTP server. This must be done before any other file transfer operation can
succeed.
[-Binary] [-Passive] [-KeepAlive] [-KeepAliveInterval <Int32<PSCredential>] [-Port <Int32>] [-Timeout <Int32>] [<CommonParameters>] |
| Connect-JFTPS |
This cmdlet establishes a connection to an FTPS server. This must be done before any other file transfer operation can
succeed.
Connect-JFTPS [-ClientCertificate <String>] [-AllowSSL] [-AllowTLS] [-ImplicitMode] [-SecureCiphers][-AcceptAllCertificates] [-Binary] [-Passive] [-KeepAlive] [-KeepAliveInterval <Int32>] [-Name] <String>[-Credential <PSCredential>] [-Port <Int32>] [-Timeout <Int32>] [<CommonParameters>] |
| Connect-JGraph |
This cmdlet establishes a connection to a Graph API server for working with mail. Use the JAMSConnection option to specify the Connection Store object for Graph API. Use the Credential option to specify the email address to monitor. You can use Get-JAMSCredential to get a valid Credential. You can use the result from this cmdlet to set the value for other cmdlets using the -MailServer parameter. [-Name] <string>] -JAMSConnection <Agent> [-Credential <PSCredential>] [-Port <int>] [-Timeout <int>] [<CommonParameters>] |
| Connect-JSFTP |
This cmdlet establishes a connection to an SFTP server. This must be done before any
other file transfer operation can succeed.
[-AcceptKey] [-Binary] [-JAMSCredential <JAMSCredential>] [-ServerType <JAMSSftpServerType>] [-Name] <String> [-Credential <PSCredential>] [-Port <Int32>] [-Timeout <Int32>] [<CommonParameters>] |
| Connect-JIMAP |
This cmdlet establishes a connection to an IMAP server. This must be done before any
other file transfer operation can succeed.
[-Authentication <ImapAuthentication>] [-Name] <String> [-Credential
<PSCredential>] [-Port <Int32>] [-Timeout <Int32>] [-SSL] [-ImplicitMode] [-SecureCiphers]
[-AcceptAllCertificates][<CommonParameters>] |
| Connect-JPOP |
This cmdlet establishes a connection to a POP server. This must be done before any
other file transfer operation can succeed.
[-Authentication <Pop3Authentication>] [-Name] <String>
[-Credential <PSCredential>] [-Port <Int32>] [-Timeout <Int32>] [-SSL] [-ImplicitMode] [-SecureCiphers] [-AcceptAllCertificates]
[<CommonParameters>] |
| Connect-JS3 |
This cmdlet establishes a connection to an S3 server. This must be done before any other file transfer operation can
succeed.
[-Bucket <String>] [-Name] <String> [-Credential <PSCredential>] [-Port <Int32>] [-Timeout <Int32>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| ConvertTo-Date |
This cmdlet
converts a natural language date specification into a date.
[-InputObject] <String> [[-Today] <DateTime>] [[-StartDate] <DateTime>] [-Server <String>] [<CommonParameters> |
| Debug-JAMSEntry |
This cmdlet debugs a JAMS entry.
Debug-JAMSEntry [[-Name] <String[]>] [-State <StateType>] [-FolderName <String>] [-PassThru] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Debug-JAMSEntry [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Debug-JAMSEntry [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Disable-JAMSTime |
This cmdlet disables a JAMS Named Time. Named Times can be automatically or manually enabled and disabled.
Disable-JAMSTime [-Name] <String[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] Disable-JAMSTime [-InputObject] <NamedTime[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Disconnect-JFS |
This cmdlet disconnects a session that was established by a Connect_Jxxx command.
[[-FileServer] <JAMSFileServer>] [<CommonParameters>] |
| Disconnect-JMS |
This cmdlet disconnects a session that was established by a Connect-JAgent, Connect-JEWS, Connect-JGraph, Connect-JIMAP, or Connect-JPOP command.
[[-MailServer] <JAMSMailServer>] [<CommonParameters>] |
| Enable-JAMSTime |
This cmdlet enables a JAMS Named Time. Named times can be automatically or manually enabled and disabled.
[-Name] <String[]> [-Server <String>] [-WhatIf] [-Confirm]
[<CommonParameters>] |
| Export-JAMSXML |
This cmdlet exports one or more JAMS Definitions to XML.
[-Path] <String> [-InputObject] <Object[]> [-IgnoreACL <SwitchParameter>] [-Server <string>] [<CommonParameters>] [-Path] <String> [-AppMenu <SwitchParameter>] [-IgnoreACL <SwitchParameter>] [-Server <string>] [<CommonParameters>] |
| Export-JKey |
This cmdlet exports all or matched JAMS Signing Keys from the default or specified Key Ring using the specified File name. File format
depends on the type of key and may be binary or ASCII armored.
[-PublicKeyRing <String>] [-SecretKeyRing <String>] -OutputFile <String> [-Fingerprint <String>] [-Identity <String>] [-PublicOnly] [-SecretOnly] [-AsciiArmor] [-KeyType <JAMSKeyType>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Find-JAMSObject |
This cmdlet
searches for objects in the JAMS database that match the query string. Objects can include an Agent, Connection Store, Credential, Execution Method, Folder, Job, Queue, or a Variable.
If the -Source option is set, the sources in Job and Execution Method definitions are searched to see if they match the query. If there is a match, the Job or Execution Method object is returned. [-Query <String>] [-Server <String>] [-SelectType <Object Type>] [-MaxCount <Number of Search Results>] [-Source] [-Recursive] [-FolderPath <String>] |
| Get-JAMSAgent |
This cmdlet lists all agents on a JAMS Server.
[[-Name] <String>] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Get-JAMSAudit |
This cmdlet retrieves Audit Trail information from a JAMS Object for the specified time window.
[[-ObjectType] <ObjectType>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [[-UserName] <String>] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Get-JAMSBookmark |
This cmdlet gets the most recent Bookmark on an executing Workflow Job. Returns a Hash table to be used when sending a response to a
Workflow Bookmark.
Get-JAMSBookmark [[-Name] <String[]>] [-State <StateType>] [-FolderName <String>] [-PassThru] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Get-JAMSBookmark [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Get-JAMSBookmark [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Get-JAMSCredential |
This cmdlet gets a set of credentials from a JAMS Server or a secret provider. The credentials are retrieved from a JAMS Credential Definition. Please note you
must have Submit access to the Credential Definition. To access values from a secret provider, you also need Execute access to Configuration. In addition, to use password security you must also have Get Password access.
[-Username] <String[]> [-Server <String>] [<CommonParameters>] |
| Get-JAMSEntry |
This cmdlet retrieves a CurJob object for each entry in the current schedule. Without parameters,
"Get-JAMSEntry" retrieves all of the entries in the schedule, as though you typed "Get-JAMSEntry *". You can also identify a particular entry by
job name or entry number or pass a CurJob object through the pipeline to Get-JAMSEntry.
[[-Name] <String>] [[-State] <StateType>] [-FolderName <String>] [-Server <String>] [<CommonParameters>] |
| Get-JAMSFailoverStatus |
This cmdlet
retrieves the failover status of a JAMS Server.
[-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Get-JAMSHistory |
This cmdlet retrieves a History object for each matching job. Without parameters, "Get-JAMSHistory" retrieves
the Job history for the current day, as though you typed "Get-JAMSHistory * -start 12:00am".
[[-Name] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [-FolderName <String>] [-JobFolderName <String>] [-Recursive] [-JobFolderRecursive] [-Status <HistoryStatus>] [-Server <String>] [<CommonParameters>] |
| Get-JAMSParameter |
This cmdlet gets the value of a JAMS Parameter from a specific entry in the schedule. When running as a part of a JAMS job, the
default is to retrieve the parameter value for the current entry.
[-Name] <String> [-Entry <Int32>] [-Server <String>] [<CommonParameters>] |
| Get-JAMSQueue |
This cmdlet gets the JAMS Queues that match the specified name. A server name can be specified to return a Queue from a remote
server.
[[-Name] <String[]>] [-Server <String>] [<CommonParameters>] |
| Get-JAMSVariable |
This cmdlet gets the JAMS Variables that match the specified name. A server name can be specified to return a variable from a
remote server.
[[-Name] <String>] [-ValueOnly] [-Server <String>] [<CommonParameters>] |
| Get-JFSChildItem |
This cmdlet gets an item from a location on a JAMS File Server. A path can be specified to get an item that is not located in the
current directory on the file server.
[[-Path] <String[]>] [-FileServer <JAMSFileServer>] [<CommonParameters>] |
| Get-JFSItem |
This cmdlet gets an item from a location on a JAMS File Server. A path can be specified to get an item that is not located in the
current directory on the file server.
[[-Path] <String[]>] [-FileServer <JAMSFileServer>] [<CommonParameters>] |
| Get-JFSLocation |
This cmdlet gets the path of the current location on the JAMS file server.
[-FileServer <JAMSFileServer>] [<CommonParameters>] |
| Get-JKey |
This cmdlet lists all or matching JAMS Signing Keys from the default or specified Key Rings.
[-PublicKeyRing <String>] [-SecretKeyRing <String>] [-Fingerprint <String>] [-Identity <String>] [-PublicOnly] [-SecretOnly] [-KeyType <JAMSKeyType>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Get-JMailHeader |
This cmdlet returns one or more MailMessageInfo objects that represent an email header. The returned objects can be used with
Get-JMailMessage to return the message body.
[-MailServer <JAMSMailServer>] [-Subject <String>] [-From <String>] [-To <String>] [-Unread] [<CommonParameters>] |
| Get-JMailMessage |
This cmdlet returns a message body for one or more MailMessageInfo objects that are retrieved from the Get-JMailHeader cmdlet.
[-MailServer <JAMSMailServer>] [-InputObject] <JAMSMailMessageInfo[]> [-WhatIf] [-Confirm] [<CommonParameters>] |
| Get-JMSFolder |
This cmdlet gets the current folder on the mail server, including Graph API.
[-MailServer <JAMSMailServer>] [<CommonParameters>] |
| Import-JAMSXml |
This cmdlet imports one or more JAMS Definitions from XML. The following definition types can be imported: Jobs, Folders, Triggers,
Menus, Methods, Resources, Variables, and Batch Queues.
[-Path] <String[]> [-IgnoreACL <SwitchParameter>][-Server <String>] [-TargetFolder <string>] [<CommonParameters>] |
| Import-JKey |
This cmdlet
imports JAMS Signing Keys from file name or file info.
[-ImportFile] <String[]> [-PublicKeyRing <String>] [-SecretKeyRing <String>] [-PublicOnly <Boolean>] [-SecretOnly <Boolean>] [-KeyType <JAMSKeyType>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] [-ImportObject] <PSObject[]> [-PublicKeyRing <String>] [-SecretKeyRing <String>] [-PublicOnly <Boolean>] [-SecretOnly <Boolean>] [-KeyType <JAMSKeyType>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| New-JKey |
This cmdlet creates a signing key using a specified key type (PGP) and algorithm. Only PGP RSA and DSA keys can be created. The new key
will be saved to the default or specified keys rings.
[-PublicKeyRing <String>] [-SecretKeyRing <String>] -Passphrase <SecureString> -RealName <String> -EmailAddress <String> [-Comment <String>] [-KeyAlgorithm <String>] [-KeyType <JAMSKeyType>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Protect-JEncryption |
This cmdlet uses the public key of the specified recipient to encrypt a file such that only that recipient can decrypt it (using their
private key).
Protect-JEncryption [-InputFile] <String[]> [-OutputFile <String>] [-AsciiArmor] [-CompressionAlgorithm <String>] [-CompressionLevel <Int32>] [-PublicKeyRing <String>] -Recipient <String> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Protect-JEncryption [-InputObject] <PSObject[]> [-OutputFile <String>] [-AsciiArmor] [-CompressionAlgorithm <String>] [-CompressionLevel <Int32>] [-PublicKeyRing <String>] -Recipient <String> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Protect-JSignature |
This cmdlet uses PGP to create a signature for one or more files, which can be binary, detached, or cleartext. Based on a private key
selected with the current user name. The recipient of the file can verify with the public key.
Protect-JSignature [-ClearSign] [-DetachSign] [-AsciiArmor] [-HashAlgorithm <String>] [-CompressionAlgorithm <String>] [-CompressionLevel <Int32>] [-InputFile] <String[]> [-OutputFile <String>] [-Sender <String>] [-Passphrase <SecureString>] [-Credential <PSCredential>] [-SecretKeyRing <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Protect-JSignature [-ClearSign] [-DetachSign] [-AsciiArmor] [-HashAlgorithm <String>] [-CompressionAlgorithm <String>] [-CompressionLevel <Int32>] [-InputObject] <PSObject[]> [-OutputFile <String>] [-Sender <String>] [-Passphrase <SecureString>] [-Credential <PSCredential>] [-SecretKeyRing <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Receive-JFSItem |
This cmdlet receives the contents of a file from a JAMS file server. A local destination can be specified for the item being received
from the file server.
[-Name] <String[]> [[-Destination] <String>] [-Recurse] [-FileServer <JAMSFileServer>] [-WhatIf][-Confirm] [<CommonParameters>] [-InputObject] <JAMSFileServerItem[]> [[-Destination] <String>] [-FileServer <JAMSFileServer>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Remove-JFSItem |
This cmdlet removes an item from a JAMS file server.
[-Path] <String[]> [-FileServer <JAMSFileServer>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Remove-JKey |
This cmdlet removes matching JAMS Signing Keys from default or specified Key Rings.
[-PublicKeyRing <String>] [-SecretKeyRing <String>] [-Fingerprint <String>] [-Identity <String>] [-PublicOnly] [-SecretOnly] [-KeyType <JAMSKeyType>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Remove-JMailMessage |
This cmdlet removes one or more mail messages from a mailbox that are retrieved from the Get-JMailHeader cmdlet. [-Path] <String[]> [-MailServer <JAMSMailServer>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Rename-JFSItem |
This cmdlet renames an item on the JAMS File Server.
[-Name] <String> [-NewName] <String> [-FileServer <JAMSFileServer>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Reset-JAMSTrigger |
This cmdlet
resets a JAMS Trigger to NOT reset when fired. A Trigger that doesn't reset
when fired stays in a "fired" state after it fires. The Trigger will not fire again until after it has
been reset.
[-Name] <String[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-InputObject] <Trigger[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Restart-JAMSEntry |
This cmdlet kills an executing JAMS entry and restarts it from the beginning.
[-Hold] [-Comment <String>] [-Severity <Severity>] [[-Name] <String[]>] [-State <StateType>][-FolderName <String>] [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Hold] [-Comment <String>] [-Severity <Severity>] [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Hold] [-Comment <String>] [-Severity <Severity>] [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Resume-JAMSEntry |
This cmdlet resumes an entry. An entry can be suspended with the Suspend-JAMSEntry command, the JAMS Client or because the Job is set to be held when
submitted.
[-Comment <String>] [[-Name] <String[]>] [-State <StateType>] [-FolderName <String>] [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Comment <String>] [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Comment <String>] [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Send-JAMSEntry |
This cmdlet allows data to be sent to a Job at runtime. The result of this command is specific to the Execution Method.
Send-JAMSEntry [-Message <String>] -Data <Hashtable> [-Comment <String>] [[-Name] <String[]>] [-State <StateType>] [-FolderName <String>] [-PassThru] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Send-JAMSEntry [-Message <String>] -Data <Hashtable> [-Comment <String>] [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Send-JAMSEntry [-Message <String>] -Data <Hashtable> [-Comment <String>] [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Send-JFSCommand |
This cmdlet
sends a command to a JAMS file server.
[-Command] <String[]> [-FileServer <JAMSFileServer>] [<CommonParameters>] |
| Send-JFSItem |
This cmdlet
sends an item to a JAMS file server. A path to the item and its destination on the file server should be specified.
[-Name] <String[]> [-Recurse] [[-Destination] <String>] [-PassThru] [-FileServer <JAMSFileServer>] [-WhatIf] [-Confirm] [<CommonParameters>] [-InputObject] <PSObject[]> [[-Destination] <String>] [-PassThru] [-FileServer <JAMSFileServer>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Set-JAMSEntry |
This cmdlet sets properties of a JAMS entry before the entry has started executing.
[-After <DateTime>] [-Queue <String>] [-Priority <Int32>] [-Hold] [-Comment <String>] [-AgentNode<String>] [[-Name] <String[]>] [-State <StateType>] [-FolderName <String>] [-PassThru] [-Server <String>] [-After <DateTime>] [-Queue <String>] [-Priority <Int32>] [-Hold] [-Comment <String>] [-AgentNode <String>] [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-After <DateTime>] [-Queue <String>] [-Priority <Int32>] [-Hold] [-Comment <String>] [-AgentNode <String>] [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Set-JAMSFailoverStatus |
This cmdlet sets the failover status of a JAMS Server.
[-Active] [-Server <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Set-JAMSParameter |
This cmdlet sets the Parameter value of an item in the current schedule. A Parameter can be changed while the Job is waiting to start or
while it is executing.
[-Name] <String> [[-Value] <Object>] [-Entry <Int32>] [-Server <String>] [-WhatIf][-Confirm] [<CommonParameters>] |
| Set-JAMSQueue |
This cmdlet sets various properties of a JAMS Queue. The available properties include: JobLimit, Name, and
Server.
[-JobLimit <Int32>] [-Name] <String[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-JobLimit <Int32>] [-InputObject] <BatchQueue[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Set-JAMSStatus |
This cmdlet sets the display text that a Job shows in the monitor. This text is displayed underneath the Job name in the monitor.
[-Status] <String> [-Entry <Int32>] [-Server <String>] [<CommonParameters>] |
| Set-JAMSVariable |
This cmdlet sets the value of a JAMS Variable.
[-Name] <String> [[-Value] <Object>] [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Set-JFSLocation |
This cmdlet sets the current location on the JAMS File Server.
[-Location] <String> [-FileServer <JAMSFileServer>] [<CommonParameters>] |
| Set-JMSFolder |
This cmdlet sets the current folder on the Graph API, EWS, IMAP, or POP3 server.
[-Folder] <String> [-MailServer <JAMSMailServer>] [<CommonParameters>] |
| Start-JAMSEntry |
This cmdlet starts a JAMS entry waiting in the current schedule by releasing one or more of the prerequisites of the Job. The default is
to remove only the next attribute that is causing the entry to not start.
[-Force] [-Comment <String>] [[-Name] <String[]>] [-State <StateType>] [-FolderName <String>] [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Force] [-Comment <String>] [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Force] [-Comment <String>] [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>][-WhatIf] [-Confirm] [<CommonParameters>] |
| Stop-JAMSEntry |
This cmdlet stops an entry or kills it if it is currently executing.
[-Force] [-Comment <String>] [-Severity <Severity>] [[-Name] <String[]>] [-State <StateType>] [-FolderName <String>] [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Force] [-Comment <String>] [-Severity <Severity>] [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Force] [-Comment <String>] [-Severity <Severity>] [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Start-JAMSQueue |
This cmdlet starts a JAMS Queue to allow Jobs to begin executing in the Queue.
[-Name] <String[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-InputObject] <BatchQueue[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Stop-JAMSQueue |
This cmdlet stops a JAMS Queue. Jobs that are executing in the Queue will continue to execute, but no new Jobs can begin until the
Queue is restarted.
[-Name] <String[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-InputObject] <BatchQueue[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-InputObject] <BatchQueue[]> [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Submit-JAMSEntry |
This cmdlet submits a new entry into the current schedule.
[-Name] <String[]> [[-After] <DateTime>] [[-Queue] <String>] [-Agent <String>] [-UserName <String>] [-AltUserName <String>] [-Comment <String>] [-OverrideName <String>] [-LogLocation <String>] [-LogFileName <String>] [-Hold] [-RunDebug] [-UseVariables] [-DependsOn <Int32[]>] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-InputJob] <Job[]> [[-After] <DateTime>] [[-Queue] <String>] [-Agent <String>] [-UserName<String>] [-AltUserName <String>] [-Comment <String>] [-OverrideName <String>] [-LogLocation <String>] [-LogFileName <String>] [-Hold] [-RunDebug] [-UseVariables] [-DependsOn <Int32[]>] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Suspend-JAMSEntry |
This cmdlet puts a manual hold on a pending or timed Job.
[-Comment <String>] [[-Name] <String[]>] [-State <StateType>] [-FolderName <String>] [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Comment <String>] [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Comment <String>] [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| Test-JSignature |
This cmdlet verifies the selected signed files based on stored public keys.
Test-JSignature [-SigFile] <String[]> [-InputFile <String>] [-PublicKeyRing <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Test-JSignature [-SigObject] <PSObject[]> [-InputFile <String>] [-PublicKeyRing <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Unprotect-JEncryption |
This cmdlet uses a private key from secret key ring to decrypt a file.
Unprotect-JEncryption [-InputFile] <String[]> [-OutputFile <String>] [-Passphrase <SecureString>] [-Credential <PSCredential>] [-SecretKeyRing <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Unprotect-JEncryption [-InputObject] <PSObject[]> [-OutputFile <String>] [-Passphrase <SecureString>] [-Credential <PSCredential>] [-SecretKeyRing <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Unprotect-JSignature |
This cmdlet removes signature from file.
Unprotect-JSignature [-SigFile] <String[]> [-OutputFile <String>] [-PublicKeyRing <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Unprotect-JSignature [-SigObject] <PSObject[]> [-OutputFile <String>] [-PublicKeyRing <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
| Wait-JAMSEntry |
This cmdlet waits until a specified JAMS entry completes or the command times out. The default timeout limit
of this cmdlet is 8 hours.
[-TimeOut <TimeSpan>] [-Severity <Severity>] [[-Name] <String[]>] [-State <StateType>] [-FolderName <String>] [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-TimeOut <TimeSpan>] [-Severity <Severity>] [-InputObject] <CurJob[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] [-TimeOut <TimeSpan>] [-Severity <Severity>] [-SubmitResult] <SubmitResult[]> [-PassThru] [-Server <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |