Skip to content

Latest commit

 

History

History

real-time-response

Confirm-RtrBatch

Batch refresh a RTR session on multiple hosts

References

Documentation, Swagger

Parameters

-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

Example

PS> Confirm-RtrBatch -Id <string>

Confirm-RtrGet

Retrieves the status of the specified batch get command

References

Swagger

Parameters

-Id: Batch Get Command Request ID received from

-Timeout: Time to wait for the command request in seconds [default: 30, maximum 600]

Example

PS> Confirm-RtrGet -Id <string>

Get-RtrFileId

Get a list of 'put' file IDs that are available to the user for the 'put' command

References

Documentation, Swagger

Parameters

-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

Example

PS> Get-RtrFileId

Get-RtrFileInfo

Get 'put' files based on the ID's given

References

Documentation, Swagger

Parameters

-Id: File IDs

Example

PS> Get-RtrFileInfo -Id @(<string>, <string>)

Get-RtrScriptId

Get a list of custom-script ID's that are available to the user for the 'runscript' command

References

Documentation, Swagger

Parameters

-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

Example

PS> Get-RtrScriptId

Get-RtrScriptInfo

Get custom-scripts based on the ID's given

References

Documentation, Swagger

Parameters

-Id: Script IDs

Example

PS> Get-RtrScriptInfo -Id @(<string>, <string>)

New-RtrFile

Upload a new put-file to use for the RTR 'put' command

References

Documentation, Swagger

Parameters

-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

Example

PS> New-RtrFile -Path <string> -Description <string>

New-RtrScript

Upload a new custom-script to use for the RTR 'runscript' command

References

Documentation, Swagger

Parameters

-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

Example

PS> New-RtrScript -Path <string> -Permission <string> -Description <string>

Receive-RtrGet

Get RTR extracted file contents for specified session and sha256

References

Swagger

Parameters

-Id: RTR Session Id

-Hash: Extracted SHA256 hash

-Path: Destination path

Example

PS> Receive-RtrGet -Id <string> -Hash <string> -Path <string>

Remove-RtrFile

Delete a 'put' file based on the ID given

References

Documentation, Swagger

Parameters

-Id: File ID

Example

PS> Remove-RtrFile -Id <string>

Remove-RtrScript

Delete a custom-script based on the ID given

References

Documentation, Swagger

Parameters

-Id: Script ID

Example

PS> Remove-RtrScript -Id <string>

Send-RtrCommand

Batch executes a RTR command across the hosts mapped to the given batch ID

References

Documentation, Swagger

Parameters

-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

Example

PS> Send-RtrCommand -Id <string> -Command <string> -String <string>

Send-RtrGet

Batch executes 'get' command across hosts to retrieve files

References

Documentation, Swagger

Parameters

-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

Example

PS> Send-RtrGet -Id <string> -Path <string>

Start-RtrBatch

Batch initialize a RTR session on multiple hosts

References

Documentation, Swagger

Parameters

-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]

Example

PS> Start-RtrBatch -Id @(<string>, <string>)