Log collection settings

Edit online

Manager log collection configuration settings that include the destination location and automatic collection details.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Log Collection Settings (logCollectionSettings) API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/logCollectionSettings.adm HTTP/1.1 Host:{manager.dsnet} scheduled={true|false}&scheduleUnit={daily|weekly}&scheduleDailyTime={hourOfDay}&sftpHostname={hostname}&sftpUsername={username}&sftpPassword={password}&sftpPath={/ftp/path}&redactionEnabled={true|false}&ibmLogTransferID={transferId}&ibmLogHostname={hostname}&ibmLogPassword={password}

Curl method

Edit online

curl -u {admin}:{password} 'https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/logCollectionSettings.adm' -d 'scheduled={true|false}&scheduleUnit={daily|weekly}&scheduleDailyTime={hourOfDay}&sftpHostname={hostname}&sftpUsername={username}&sftpPassword={password}&sftpPath={/ftp/path}&redactionEnabled={true|false}&ibmLogTransferID={transferId}&ibmLogHostname={hostname}&ibmLogPassword={password}'

Parameters

Edit online
Table 2. Request Parameters for Log Collection Settings (logCollectionSettings) API method
Parameter Type Usage Default Description
logCollectionProtocol String Optional unset

Transfer protocol to use unset, sftp or http.
username String if logCollectionProtocol=sftp or (logCollection Protocol=http and authenticated=true)  

User name that is used by the devices to log in to the destination server.
password String  

Password to use along with the username when logging in to the destination server.
hostname String Required if logCollection Protocol is http or sftp.  

Path where each device to place its collected logs.

Whether it is the absolute path or relative path depends on the destination server configuration.
path String Required if logCollection Protocol is http or sftp.  

Host name or IP address of the destination server.
usingCustomPort Boolean   80 or 443 if secure=true

HTTP transfer uses a non-default port.
port Integer If usingCustomPort=true 80 or 443 if secure=true

Port for HTTP transfers.
secure Boolean Optional  

Use HTTPS for transfers.
authenticated Boolean    

Destination HTTP server requires authentication or not.
proxyEnabled Boolean    

HTTP transfer should work through an HTTP proxy or not.

If true

Subset of the parameters below must be given.
managerAsProxy Boolean    

The Manager device automatically configures itself to act as a proxy server used for HTTP transfers:

If true

Proxy opens on the Manager device. It allows only devices in the system access through it. No parameters are needed.

If false

Set proxyHostname
proxyHostname String If managerAsProxy=false  

Host name to use for HTTP proxy server.
proxyPort Integer   80

Port for HTTP proxy server.
proxyAuthenticated Boolean    

HTTP proxy server requires authentication.
proxyUsername String If proxy authenticated=true  

User name that is used to authenticate with HTTP proxy server.
proxyPassword String   Password that is used to authenticate with HTTP proxy server.
scheduled Boolean    

Automatically schedule log collection or not.
scheduleUnit String If scheduled=true  

Type of automatic schedule to create. Options are:

daily

Past 24 hours of logs are collected.

weekly

Last week’s logs are collected.
scheduleDailyTime Integer if scheduleUnit= daily 0

A number 0 - 23, inclusive, representing the hour of the day to collect logs.
scheduleWeeklyDay Integer if scheduleUnit= weekly 1

A number 1 - 7, inclusive, representing the day of the week to collect logs.

Sunday(1), Monday(2), … Saturday(7).
scheduleWeeklyTime Integer 0

A number 0 - 23, inclusive, representing the hour of the day to collect logs.
deviceTypes String    

A list of device types to collect logs for. Device types are:

  • manager
  • accesser
  • slicestor
deviceTypes=manager
&deviceTypes=accesser
categories String    

List of categories, which correspond to the type of log files to be collected.

Categories are

  • manager
  • core
  • platform
  • storage
categories=manager
&categories=core
Note:
  • If no parameters are given, the previous values are retained.
  • Automatic log collection cannot be set up without a configured SFTP destination.
redactionEnabled Boolean Optional False Indicates whether client information will be redacted in content included in dump logs
ibmLogTransferId String Optional   Transfer Id used by devices to log into the IBM Log Server
ibmLogPassword String Optional   Password used by devices to log into the IBM Log Server
ibmLogHostname String Optional   Hostname or IP address of IBM Log Server
ftpSshKeyAlgorithm String   ED25519 The algorithm to use when generating the SSH key. Allowable values are ED25519, ECDSA, and RSA