Batch refresh a RTR session on multiple hosts
-Id
: Batch ID to execute the command on
-Timeout
: Timeout for how long to wait for the request in seconds [default: 30, maximum 600]
-Remove
: An array of agent IDs to remove from the batch session. Heartbeats will no longer happen on these
hosts and the sessions will expire
PS> Confirm-RtrBatch -Id <string>
Retrieves the status of the specified batch get command
-Id
: Batch Get Command Request ID received from
-Timeout
: Time to wait for the command request in seconds [default: 30, maximum 600]
PS> Confirm-RtrGet -Id <string>
Get a list of 'put' file IDs that are available to the user for the 'put' command
-Filter
: The filter expression that should be used to limit the results
-Limit
: The maximum records to return [default: 5000]
-Offset
: The offset to start retrieving records from [default: 0]
-All
: Repeat request until all results are returned
PS> Get-RtrFileId
Get 'put' files based on the ID's given
-Id
: File IDs
PS> Get-RtrFileInfo -Id @(<string>, <string>)
Get a list of custom-script ID's that are available to the user for the 'runscript' command
-Filter
: The filter expression that should be used to limit the results
-Limit
: The maximum records to return [default: 5000]
-Offset
: The offset to start retrieving records from [default: 0]
-All
: Repeat request until all results are returned
PS> Get-RtrScriptId
Get custom-scripts based on the ID's given
-Id
: Script IDs
PS> Get-RtrScriptInfo -Id @(<string>, <string>)
Upload a new put-file to use for the RTR 'put' command
-Path
: Full path to the file to upload
-Description
: File description
-Name
: File name (if different than actual file name)
-Comment
: The audit log comment
PS> New-RtrFile -Path <string> -Description <string>
Upload a new custom-script to use for the RTR 'runscript' command
-Path
: Full path to the script you wish to upload
-Permission
: Permission for the custom-script [default: private]
-Description
: File description
-Name
: File name (if different than actual file name)
-Comment
: The audit log comment
PS> New-RtrScript -Path <string> -Permission <string> -Description <string>
Get RTR extracted file contents for specified session and sha256
-Id
: RTR Session Id
-Hash
: Extracted SHA256 hash
-Path
: Destination path
PS> Receive-RtrGet -Id <string> -Hash <string> -Path <string>
Delete a 'put' file based on the ID given
-Id
: File ID
PS> Remove-RtrFile -Id <string>
Delete a custom-script based on the ID given
-Id
: Script ID
PS> Remove-RtrScript -Id <string>
Batch executes a RTR command across the hosts mapped to the given batch ID
-Id
: Batch ID to execute the command on
-Command
: Command to execute
-String
: Command string (text that follows the 'base command')
-Timeout
: Time to wait for the command request in seconds [default: 30, maximum 600]
-Optional
: List of a subset of hosts we want to run the command on. If this list is supplied, only
these hosts will receive the command
PS> Send-RtrCommand -Id <string> -Command <string> -String <string>
Batch executes 'get' command across hosts to retrieve files
-Id
: Batch ID to execute the command on
-Path
: Full path to the file that is to be retrieved from each host in the batch
-Timeout
: Time to wait for the command request in seconds [default: 30, maximum 600]
-Optional
: List of a subset of hosts we want to run the command on. If this list is supplied, only
these hosts will receive the command
PS> Send-RtrGet -Id <string> -Path <string>
Batch initialize a RTR session on multiple hosts
-Id
: List of host agent IDs to initialize a RTR session on
-Existing
: Optional batch ID. Use an existing batch ID if you want to initialize new hosts and
add them to an existing batch
-Timeout
: Time to wait for the command request to complete, in seconds [default: 30, maximum 600]
PS> Start-RtrBatch -Id @(<string>, <string>)