exports/New-JcSdkRadiusServer.ps1
|
<# .Synopsis This endpoint allows you to create RADIUS servers in your organization.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/radiusservers/ \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"{test_radius}\",\n \"networkSourceIp\": \"{0.0.0.0}\",\n \"sharedSecret\":\"{secretpassword}\",\n \"userLockoutAction\": \"REMOVE\",\n \"userPasswordExpirationAction\": \"MAINTAIN\"\n}'\n``` .Description This endpoint allows you to create RADIUS servers in your organization.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/radiusservers/ \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"{test_radius}\",\n \"networkSourceIp\": \"{0.0.0.0}\",\n \"sharedSecret\":\"{secretpassword}\",\n \"userLockoutAction\": \"REMOVE\",\n \"userPasswordExpirationAction\": \"MAINTAIN\"\n}'\n``` .Example To view examples, please use the -Online parameter with Get-Help or navigate to: https://docs.microsoft.com/en-us/powershell/module/jumpcloud.sdk.v1/new-jcsdkradiusserver .Inputs JumpCloud.SDK.V1.Models.IRadiusserverpost .Outputs JumpCloud.SDK.V1.Models.IRadiusserver .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. BODY <IRadiusserverpost>: RadiusServerPost Name <String>: NetworkSourceIP <String>: SharedSecret <String>: RADIUS shared secret between the server and client. [Mfa <String>]: [TagNames <String[]>]: [UserLockoutAction <String>]: [UserPasswordExpirationAction <String>]: .Link https://docs.microsoft.com/en-us/powershell/module/jumpcloud.sdk.v1/new-jcsdkradiusserver #> function New-JcSdkRadiusServer { [OutputType([JumpCloud.SDK.V1.Models.IRadiusserver])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Create', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V1.Category('Body')] [JumpCloud.SDK.V1.Models.IRadiusserverpost] # RadiusServerPost # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='CreateExpanded', Mandatory)] [JumpCloud.SDK.V1.Category('Body')] [System.String] # HELP MESSAGE MISSING ${Name}, [Parameter(ParameterSetName='CreateExpanded', Mandatory)] [JumpCloud.SDK.V1.Category('Body')] [System.String] # HELP MESSAGE MISSING ${NetworkSourceIP}, [Parameter(ParameterSetName='CreateExpanded', Mandatory)] [JumpCloud.SDK.V1.Category('Body')] [System.String] # RADIUS shared secret between the server and client. ${SharedSecret}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V1.Category('Body')] [System.String] # HELP MESSAGE MISSING ${Mfa}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V1.Category('Body')] [System.String[]] # HELP MESSAGE MISSING ${TagNames}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V1.Category('Body')] [System.String] # HELP MESSAGE MISSING ${UserLockoutAction}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V1.Category('Body')] [System.String] # HELP MESSAGE MISSING ${UserPasswordExpirationAction}, [Parameter(DontShow)] [JumpCloud.SDK.V1.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V1.Category('Runtime')] [JumpCloud.SDK.V1.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V1.Category('Runtime')] [JumpCloud.SDK.V1.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter(DontShow)] [JumpCloud.SDK.V1.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V1.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [JumpCloud.SDK.V1.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ Create = 'JumpCloud.SDK.V1.private\New-JcSdkRadiusServer_Create'; CreateExpanded = 'JumpCloud.SDK.V1.private\New-JcSdkRadiusServer_CreateExpanded'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |