Skip to content

Add-vRLILogForwarder

Synopsis

Adds a log forwarder destination to VMware Aria Operations for Logs

Syntax

Add-vRLILogForwarder [-server] <String> [-user] <String> [-pass] <String> [-name] <String> [-fqdn] <String> [-protocol] <String> [-port] <String> [[-transport] <String>] [-acceptCert] <String> [-sslEnabled] <String> [-testConnection] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

The Add-vRLILogForwarder cmdlet adds log forwarder destination to VMware Aria Operations for Logs. The cmdlet connects to SDDC Manager using the -server, -user, and -password values:

  • Validates that network connectivity and authentication is possible to SDDC Manager
  • Validates that VMware Aria Operations for Logs has been deployed in VCF-aware mode and retrieves its details
  • Validates that network connectivity and authentication is possible to VMware Aria Operations for Logs
  • Adds a log forwarder destination to VMware Aria Operations for Logs

Examples

Example 1

Add-vRLILogForwarder -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -name "SFO to LAX" -fqdn lax-vrli01.lax.rainpole.io -protocol SYSLOG -port 514 -transport TCP -acceptCert false -sslEnabled false -testConnection false

This example adds a log forwarder to VMware Aria Operations for Logs using syslog over TCP 514.

Example 2

Add-vRLILogForwarder -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -name "SFO to LAX" -fqdn lax-vrli01.lax.rainpole.io -protocol CFAPI -port 9543 -acceptCert true -sslEnabled true -testConnection true

This example adds a log forwarder destination to VMware Aria Operations for Logs.

Parameters

-server

The fully qualified domain name of the SDDC Manager.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-user

The username used to authenticate to SDDC Manager.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-pass

The password used to authenticate to SDDC Manager.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-name

The name of the log forwarder destination.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-fqdn

The fully qualified domain name of the log forwarder destination.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-protocol

The protocol to use for the log forwarder destination. "CFAPI", "SYSLOG", "RAW".

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-port

The port to use for the log forwarder destination.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-transport

The transport to use for the log forwarder destination. "TCP", "UDP".

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-acceptCert

Accepts the certificate for the log forwarder destination. "true", "false".

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-sslEnabled

Enables SSL for the log forwarder destination. "true", "false".

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-testConnection

Tests the connection to the log forwarder destination. "true", "false".

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Progress Action

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Common Parameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.