Get-OctopusUser

NAME Get-OctopusUser



SYNOPSIS

This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)





SYNTAX

Get-OctopusUser [[-UserName] <string[]>] [-ResourceOnly <SwitchParameter>] [<CommonParameters>]





DESCRIPTION

This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)





PARAMETERS

-UserName <string[]>

User Name. Accepts wildcard



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <string[]>

User Name. Accepts wildcard



This is an alias of the UserName parameter.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ResourceOnly <SwitchParameter>

If set to TRUE the cmdlet will return the basic Octopus resource. If not set or set to FALSE, the cmdlet will

return a human friendly Octoposh output object



Required? false

Position? named

Default value False

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

System.String[]

User Name. Accepts wildcard





OUTPUTS

System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusMachine, Octoposh, Version=1.0.0.0,

Culture=neutral, PublicKeyToken=null]]



System.Collections.Generic.List`1[[Octopus.Client.Model.MachineResource, Octopus.Client, Version=4.22.0.0,

Culture=neutral, PublicKeyToken=null]]





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



PS C:\\> Get-OctopusUser



Gets all the Users on the Octopus instance

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



PS C:\\> Get-OctopusUser -Username "Jotaro Kujo"



Gets the user with the Username "Jotaro Kujo"

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



PS C:\\> Get-OctopusUser -Username "Jotaro Kujo","Dio Brando"



Gets the users with the Usernames "Jotaro Kujo" and "Dio Brando"

---------- EXAMPLE 4 ----------



PS C:\\> Get-OctopusUser -Username "*Joestar"



Gets all the users whose username ends with "Joestar"



RELATED LINKS

WebSite: http://Octoposh.net

Github Project: https://github.com/Dalmirog/OctoPosh/

Wiki: http://octoposh.readthedocs.io

QA and Feature requests: https://gitter.im/Dalmirog/OctoPosh#initial