internal/autorest/out/system/Get-DracoonARSystemConfigSettingSyslog.ps1
|
function Get-DracoonARSystemConfigSettingSyslog { <# .SYNOPSIS Request syslog settings .DESCRIPTION <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>🚀 Since v4.6.0</h3> ### Description: DRACOON syslog configuration entry point. ### Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>🔓 read global config</span> and role <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>👤 Config Manager</span> of the Provider Customer required. ### Postcondition: Returns a list of configurable syslog settings. ### Further Information: None. ### Configurable syslog settings: <details open style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;"> <summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary> | Setting | Description | Value | | :--- | :--- | :--- | | `enabled` | Determines whether syslog is enabled. | `true or false` | | `host` | Syslog server (IP or FQDN) | `DNS name or IPv4 of a syslog server` | | `port` | Syslog server port | `Valid port number` | | `protocol` | Protocol to connect to syslog server | `TCP or UDP` | | `logIpEnabled` | Determines whether user’s IP address is logged. | `true or false` | </details> .PARAMETER Connection Object of Class ARAHConnection, stores the authentication Token and the API Base-URL .PARAMETER XSdsAuthToken Authentication token .EXAMPLE PS C:\> Get-DracoonARSystemConfigSettingSyslog -Connection $connection <h3 style='padding: 5px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px; display: table-cell;'>🚀 Since v4.6.0</h3> ### Description: DRACOON syslog configuration entry point. ### Precondition: Right <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>🔓 read global config</span> and role <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>👤 Config Manager</span> of the Provider Customer required. ### Postcondition: Returns a list of configurable syslog settings. ### Further Information: None. ### Configurable syslog settings: <details open style="padding: 10px; background-color: #F6F7F8; border: 1px solid #AAA; border-radius: 5px;"> <summary style="cursor: pointer; outline: none"><strong>Expand</strong></summary> | Setting | Description | Value | | :--- | :--- | :--- | | `enabled` | Determines whether syslog is enabled. | `true or false` | | `host` | Syslog server (IP or FQDN) | `DNS name or IPv4 of a syslog server` | | `port` | Syslog server port | `Valid port number` | | `protocol` | Protocol to connect to syslog server | `TCP or UDP` | | `logIpEnabled` | Determines whether user’s IP address is logged. | `true or false` | </details> .LINK <unknown> #> [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [object] $Connection, [Parameter(ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $XSdsAuthToken ) process { $__mapping = @{ 'Connection' = 'Connection' 'XSdsAuthToken' = 'X-Sds-Auth-Token' } $__body = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping $__query = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @() -Mapping $__mapping $__header = $PSBoundParameters | ConvertTo-DracoonARHashtable -Include @('XSdsAuthToken') -Mapping $__mapping $__path = 'system/config/settings/syslog' Invoke-DracoonAPI -Path $__path -Method get -Body $__body -Query $__query -Header $__header -Connection $Connection } } |