Set HPOVRemoteSyslog - HewlettPackard/POSH-HPEOneView GitHub Wiki
Configure remote syslog.
Set-HPOVRemoteSyslog [-Destination] <IPAddress> [-Port] <Int32>[ [-SendTestMessage] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]The remoteSyslog API provides the ability to configure remote logging on devices managed by OneView. This Cmdlet handles setting or updating the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance will deploy the SysLog settings to managed resources automatically.
-ApplianceConnection <Object>
Aliases [-Appliance]
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | false |
| Position? | named |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Async <SwitchParameter>
Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Destination <IPAddress>
Destination IPv4 Address of the Remote SysLog.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Port <Int32>
The destination TCP port.
Default value: 514
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | 514 |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-SendTestMessage <SwitchParameter>
Use to generate a syslog test message after the managed endpoint has finished configuring.
| Aliases | None |
| 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 (http://go.microsoft.com/fwlink/?LinkID=113216)
None. You cannot pipe objects to this Cmdlet.
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
If successful, returns Appliance Async Task object to monitor
System.Collections.ArrayList <HPOneView.Appliance.TaskResource>
Collection of Appliance Async Task objects to monitor
-------------------------- EXAMPLE 1 --------------------------Set-HPOVRemoteSyslog -Destination 10.150.20.1 -SendTestMessage -Async | Wait-HPOVTaskComplete
Set the remote syslog to the provided destination, using the default destination TCP port, and send a test message for all connected appliances.
Configure remote syslog.
Set-HPOVRemoteSyslog [-Destination] <IPAddress> [-Port] <Int32>[ [-SendTestMessage] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]The remoteSyslog API provides the ability to configure remote logging on devices managed by OneView. This Cmdlet handles setting or updating the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance will deploy the SysLog settings to managed resources automatically.
-ApplianceConnection <Object>
Aliases [-Appliance]
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | false |
| Position? | named |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Async <SwitchParameter>
Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Destination <IPAddress>
Destination IPv4 Address of the Remote SysLog.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Port <Int32>
The destination TCP port.
Default value: 514
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | 514 |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-SendTestMessage <SwitchParameter>
Use to generate a syslog test message after the managed endpoint has finished configuring.
| Aliases | None |
| 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 (http://go.microsoft.com/fwlink/?LinkID=113216)
None. You cannot pipe objects to this Cmdlet.
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
If successful, returns Appliance Async Task object to monitor
System.Collections.ArrayList <HPOneView.Appliance.TaskResource>
Collection of Appliance Async Task objects to monitor
-------------------------- EXAMPLE 1 --------------------------Set-HPOVRemoteSyslog -Destination 10.150.20.1 -SendTestMessage -Async | Wait-HPOVTaskComplete
Set the remote syslog to the provided destination, using the default destination TCP port, and send a test message for all connected appliances.