Get-EmpireAgent

NAME Get-EmpireAgent



SYNOPSIS

Get agents on a Epire server.





SYNTAX

Get-EmpireAgent [-Id] <Int32> [-NoSSLCheck] [-Stale] [-Name <String>] [<CommonParameters>]



Get-EmpireAgent [-Token] <String> [-ComputerName] <String> [[-Port] <Int32>] [-NoSSLCheck] [-Stale] [-Name

<String>] [<CommonParameters>]





DESCRIPTION

Get all current agents on a Epire server.





PARAMETERS

-Id <Int32>

Empire session Id of the session to use.



Required? true

Position? 1

Default value 0

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Token <String>

Empire API token to use to execute the action.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ComputerName <String>

IP Address or FQDN of remote Empire server.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Port <Int32>

Port number to use in the connection to the remote Empire server.



Required? false

Position? 3

Default value 1337

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-NoSSLCheck [<SwitchParameter>]

Do not check if the TLS/SSL certificate of the Empire is valid.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Stale [<SwitchParameter>]

Get all stale agents when a name is not given.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

Name of agent to get.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Empire.Agent





NOTES





Licensed under BSD 3-Clause license



-------------------------- EXAMPLE 1 --------------------------



C:\\PS>Get-EmpireAgent -Id 0



Get all current agents for the Empire server in the session.









-------------------------- EXAMPLE 2 --------------------------



C:\\PS>Get-EmpireAgent -Id 0 -Stale



Get all stale agents for the Empire server in the session.









-------------------------- EXAMPLE 3 --------------------------



C:\\PS>Get-EmpireAgent -Id 0 -Name DC01



Get the agent with the name DC01 for the Empire server in the session.











RELATED LINKS