< Back

Get-JCRadiusServer

Thu Jan 16, 2020 8:55 am

NAME Get-JCRadiusServer



SYNOPSIS

Return JumpCloud radius server information.





SYNTAX

Get-JCRadiusServer [-Id] <System.String[]> [[-Fields] <System.Array>] [[-Filter] <System.String>] [[-Limit]

<System.Int32>] [[-Skip] <System.Int32>] [[-Paginate] <System.Boolean>] [-Force] [<CommonParameters>]



Get-JCRadiusServer [-Name] <System.String[]> [[-Fields] <System.Array>] [[-Filter] <System.String>] [[-Limit]

<System.Int32>] [[-Skip] <System.Int32>] [[-Paginate] <System.Boolean>] [-Force] [<CommonParameters>]





DESCRIPTION

Use this function to return radius servers from JumpCloud tenet.





PARAMETERS

-Fields <System.Array>

An array of the fields/properties/columns you want to return from the search.



Required? false

Position? 95

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Filter <System.String>

Filters to narrow down search.



Required? false

Position? 96

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Force <System.Management.Automation.SwitchParameter>

Bypass user prompts and dynamic ValidateSet.



Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Id <System.String[]>

The unique id of the object.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Limit <System.Int32>

The number of items you want to return per API call.



Required? false

Position? 97

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <System.String[]>

The name of the object.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Paginate <System.Boolean>

Whether or not you want to paginate through the results.



Required? false

Position? 99

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Skip <System.Int32>

The number of items you want to skip over per API call.



Required? false

Position? 98

Default value None

Accept pipeline input? True (ByPropertyName)

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.Management.Automation.SwitchParameter





System.String[]





System.String





System.Array





System.Int32





System.Boolean







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Get-JCRadiusServer



Returns all radius servers from a JumpCloud tenet.

-------------------------- Example 2 --------------------------



PS C:\\> Get-JCRadiusServer -Id:('5d6802c46eb05c5971151558')



Returns a radius server by Id from a JumpCloud tenet.

-------------------------- Example 3 --------------------------



PS C:\\> Get-JCRadiusServer -Name:('RadiusServer1')



Returns a radius server by Name from a JumpCloud tenet.



RELATED LINKS

Online Version: https://github.com/TheJumpCloud/support ... diusServer