Skip to content

Set HPOVRemoteSyslog

Jump to bottom
Chris Lynch edited this page Jul 25, 2016 · 32 revisions

Library Version 2.00

HPE OneView 2.00 Library

Set-HPOVRemoteSyslog

Configure remote syslog.

SYNTAX

Set-HPOVRemoteSyslog [-Destination] <IPAddress> [-Port] <Int32>[ [-SendTestMessage] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

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.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectSessions}

Aliases Appliance
Required? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-Destination <IPAddress>

Destination IPv4 Address of the Remote SysLog.

Aliases None
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Port <Int32>

The destination TCP port.

Default value: 514

Aliases None
Required? true
Position? 1
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)

Input Types

None. You cannot pipe objects to this Cmdlet.

Return Values

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.

Examples

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

PS C:\> Set-HPOVRemoteSyslog -Destination 10.150.20.1 -SendTestMessage | 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.

Related Links

Wiki Table of Contents

Clone this wiki locally