Outputting a configuration report

Provisioning Guide for VSP One Block

Version
10.2.x
Audience
anonymous
Part Number
MK-23VSP1B012-00

One of the following roles is required to perform this task:

  • Storage Administrator (View Only)
  • User Maintenance
  • Support Personnel (Vendor Only)

If you perform the operation by using a session created with the REST API, use the service IP address.

If you use the IP address of the management port or the maintenance port, use the authentication with the user name and the password. The authentication method with the user name and the password is the same as when creating the session. For more information about how to create the session, see the REST API Reference Guide.

  1. Create a configuration report.

    Request line:

    POST <Base URL >/v1/objects/configuration-reports

    Indicates the body of the request::

    {
    "reportName”: "CreateConfigurationReport"
    }

    Indicates the contents of each item displayed in the response:

    {
    state”:”Creating”,
    “reportName”:"CreateConfigurationReport",
    “userId”:"user01", 
    “reportId”:"CL1,0",
    “createdTime”:"-",
    "messageId":"-",
    "errMessage:"-",
    “errFiles”:["-"]
    }
    Attribute Type Description
    state string
    • "-": No indication to create a configuration report
    • "Ready": Configuration report can be downloaded
    • "Creating": Creating configuration report
    • "Downloading": Downloading configuration report
    • "Warning": Partial failure to create configuration report
    • "Failed": Configuration report cannot be created
    reportName string Name of the configuration report
    reportId string
    • Report ID
    • < Controller designation > , 0

    Example: 1,0 or CL2,0

    UserId string User ID of the requesting user
    createdTime string Configuration report creation time

    format: yyyy-mm-ddThh:mm:ss

    messageId string Message ID
    errMessage string Error message
    errFiles string[] File names that cannot be created when creating a configuration report
  2. Verify the status of the process for creating a configuration report.

    Request line:

    GET <Base URL >/v1/objects/configuration-reports

    Displays the same response as step 1. Repeat until "state" is "Ready". It takes about 10 minutes.

  3. Download the configuration report.

    Request line:

    POST <Base URL >/v1/objects/configuration-reports/{
    reportId}/actions/download/invoke

    For reportId, specify the report ID.

    The downloaded file is output in tar.gz.

    The configuration report created on CTL1 cannot be downloaded from CTL2. Similarly, the configuration report created on CTL2 cannot be downloaded from CTL1.

  4. (Optional) Save the file using the tar.gz or .tgz extension.
  5. If ESM fails over, re-create the configuration report.