Skip to main content
Pure1 Support Portal

purelog

Name

purelog, purelog-create, purelog-delete, purelog-global, purelog-list, purelog-setattr, purelog-test — manages connections to syslog servers

Synopsis

purelog create --uri URI NAME

purelog delete NAME...

purelog global disable --tls-audit

purelog global enable --tls-audit

purelog global list [--ca-certificate] [ --cli | --csv | --nvp ] [--notitle] [--page] [--raw]

purelog global setattr --ca-certificate

purelog list [ --cli | --csv | --nvp ] [ --notitle | --raw ] [NAME...]

purelog setattr --uri URI NAME

purelog test

Arguments

NAME

Name used by Purity to identify a syslog server.

Options

-h | --help

Can be used with any command or subcommand to display a brief syntax description.

--ca-certificate

Import or display the Certificate Authority's (CA) certificate.

Purity's syslog agent uses the CA's certificate in communicating with syslog servers using the TLS protocol.

--tls-audit

Forward messages needed for TLS auditing.

--uri URI

Creates or sets the URI of the remote syslog server. For example, tcp://MyHost.com.

Specify the URI in the format PROTOCOL://HOSTNAME:PORT.

PROTOCOL is "tcp", "tls", or "udp".

HOSTNAME is the syslog server hostname or IP address. If specifying an IP address, for IPv4, specify the IP address in the form ddd.ddd.ddd.ddd, where ddd is a number ranging from 0 to 255 representing a group of 8 bits.

For IPv6, specify the IP address in the form [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx], where xxxx is a hexadecimal number representing a group of 16 bits. Enclose the entire address in square brackets ([]). Consecutive fields of zeros can be shortened by replacing the zeros with a double colon (::).

PORT is the port at which the server is listening. If a port number is specified, append it to the end of the address. If the port is not specified, it defaults to 514.

Options that control display format:

--cli

Displays output in the form of CLI commands that can be issued to reproduce the current configuration. The --cli output is not meaningful when combined with immutable attributes.

--csv

Lists information in comma-separated value (CSV) format. The --csv output can be used for scripting purposes and imported into spreadsheet programs.

--notitle

Lists information without column titles.

--nvp

Lists information in name-value pair (NVP) format, in the form ITEMNAME=VALUE. Argument names and information items are displayed flush left. The --nvp output is designed both for convenient viewing of what might otherwise be wide listings, and for parsing individual items for scripting purposes.

--page

Turns on interactive paging.

--raw

Displays the unformatted version of column titles and data. For example, in the purearray monitor output, the unformatted version of column title us/op (read) is usec_per_read_op. The --raw output is used to sort and filter list results.

Description

Purity's syslog agent can forward syslog messages to syslog servers.

The purelog command can be used for configuring Purity's syslog agent to communicate with syslog servers.

Using Secure Transport

Syslog messages can be forwarded using the TLS protocol.

SSL certificate installed using the purecert command is used by Purity's syslog agent to authenticate itself to syslog servers.

purelog global setattr --ca-certificate can be used to import the CA's certificate that Purity's syslog agent will use for authenticating the syslog servers.

purelog Subcommands

Subcommands of the purelog command configures, displays and sets attributes of syslog servers.

The purelog create subcommand configures a syslog server. Transmission of syslog messages is enabled immediately upon configuring the syslog server.

The purelog delete subcommand deletes the configured syslog server and stops forwarding syslog messages to the syslog server.

The purelog global enable subcommand enables global options.

The purelog global disable subcommand disables global options.

The purelog global list subcommand displays global configuration.

The purelog global setattr subcommand sets global attributes.

The purelog list subcommand displays the configured syslog servers.

The purelog setattr subcommand sets syslog server attributes.

The purelog test subcommand sends a test message to syslog servers. Verification of successful test message transmission is done at the destination.

Examples

Example 1

purelog create --uri tcp://MyHost.com LOGSERVER1
      

Configures a syslog server named LOGSERVER1 running on host MyHost.com, using TCP and at the default port 514.

This immediately enables transmission of all future syslog messages to LOGSERVER1.

Example 2

purelog create --uri tcp://[2001:0db8:85a3::ae26:8a2e:0370:7334]:614 LOGSERVER2
      

Configures a syslog server named LOGSERVER2 running on host 2001:0db8:85a3::ae26:8a2e:0370:7334, using TCP and at port 614.

This immediately enables transmissions of all future syslog messages to LOGSERVER2.

Example 3

purelog delete LOGSERVER2
      

Stops transmission of future syslog messages to LOGSERVER2 and deletes the configured syslog server.

Example 4

purelog list LOGSERVER3
      

Displays the URI for LOGSERVER3.

Example 5

purelog global disable --tls-audit
      

Disables TLS audit for all syslog servers.

Example 6

purelog global enable --tls-audit
      

Enables TLS audit for all syslog servers.

Syslog messages needed for TLS auditing are forwarded to all configured syslog servers.

Example 7

purelog global list
      

Displays global options.

Example 8

purelog global list --ca-certificate
      

Displays the imported CA certificate.

Example 9

purelog global setattr --ca-certificate
      

Import CA certificate.

Example 10

purelog setattr --uri tcp://MyHost.com LOGSERVER1
      

Set URI for LOGSERVER1 to tcp://MyHost.com.

See Also

purearray(1)

Author

Pure Storage Inc.