Manage myStorNext Uploads from Your API Gateway
Use the following commands if you need to create a license report to manually upload to myStorNext, display or add myStorNext login credentials, or display and set the time of daily license report uploads to myStorNext from your API gateway.
Use the apigw mystornext command to perform the following:
- Automatic Upload of the License Report: To start the automatic upload, the account username must already be configured (see Add a User onYour API Gateway). The automatic upload option uploads the license report at a time determined randomly at installation time. To configure the upload schedule to a specific time, see Configure the License Report Schedule for myStorNext on Your API Gateway.
- Manual Upload of the License Report: The manual upload requires you create the license report file (see Create a License Report for myStorNext on Your API Gateway). A license report file is saved to the directory /tmp/quantum/api-gw/license. By default, license report files are deleted after seven days, unless you change the expiration (see Configure the License Report Schedule for myStorNext on Your API Gateway).
Note: For a list of all the API gateway commands, see API Gateway (APIGW) Command Index.
- Open an SSH connection to the API gateway and log in.
- At the prompt, enter the following:
- Below is an example of the output:
- If you need to manually upload your license report file on myStorNext, you can export the license report file to a local destination and then upload your license report file on myStorNext (https://stornext.quantum.com).
- On myStorNext, click Licensing Reporting.
- Click Upload License Report. The Upload License Report dialog appears.
Click Select File or Browse, and then navigate to the local destination where you exported the license report file to.
Note: The license file must be in plain text format and contain a JSON string.
- Click Upload to proceed with the operation or click Cancel to abort the operation and return to the previous page.
- If the upload is successful, the Successfully uploaded indicator appears at the top of the page.
/opt/quantum/api-gateway/bin/apigw mystornext license
This may take a few minutes License report in /tmp/quantum/api-gw/license/mystornext-license-20200625160141.json
Note: By default, a license report file is deleted after seven days, unless you change the expiration (see Configure the License Report Schedule for myStorNext on Your API Gateway).
- Open an SSH connection to the API gateway and log in.
- At the prompt, enter the following:
- Below is an example of the output:
/opt/quantum/api-gateway/bin/apigw mystornext account
- Open an SSH connection to the API gateway and log in.
- At the prompt, enter the following:
/opt/quantum/api-gateway/bin/apigw mystornext account OPTION
Below is the available option for the mystornext account command.
Option | Description. |
---|---|
|
This option allows you to specify the account username for myStorNext. |
Example
/opt/quantum/api-gateway/bin/apigw mystornext account -u john.doe@domain.com
- Open an SSH connection to the API gateway and log in.
- At the prompt, enter the following:
- Below is an example of the output:
/opt/quantum/api-gateway/bin/apigw mystornext schedule
mystornext_license_upload_hour=18
mystornext_license_upload_minute=53
license_purge_expiration_in_days=7
Caution: You must restart your API gateway after you configure the schedule.
Note: The time you specify by running the command below is in UTC, which might be a different time zone set on your API gateway host.
- Open an SSH connection to the API gateway and log in.
- At the prompt, enter the following:
-
Below is an example of the output:
/opt/quantum/api-gateway/bin/apigw mystornext schedule OPTIONS
Below are the available options for the mystornext schedule command.
Option | Description. |
---|---|
|
This option allows you to specify the hour of day (UTC timezone) to upload the license report file to myStorNext. |
|
This option allows you to specify the minute of hour to upload the license report file to myStorNext. |
|
This option allows you to configure the schedule at a randomly determined time of day to upload the license report file to myStorNext. |
|
This option allows you to configure the number of days an old license report file (see Create a License Report for myStorNext on Your API Gateway) must be before it is removed from the directory /tmp/quantum/api-gw/license on this host. |
Example
/opt/quantum/api-gateway/bin/apigw mystornext schedule -H 23 -M 45 -p 30
myStorNext upload schedule saved. Requires api-gateway stack restart. Restart Now? [y|n] y Removing service quantum-api_endpoint-database Removing service quantum-api_gateway-admin-api Removing service quantum-api_keycloak-database Removing service quantum-api_keycloak-server Removing service quantum-api_kong-database Removing service quantum-api_kong-server Removing service quantum-api_license-aggregator Removing service quantum-api_license-sender Removing service quantum-api_rest-aggregator-activescale-hosts Removing service quantum-api_rest-aggregator-appliance-controller-hosts Removing service quantum-api_rest-aggregator-datamovers Removing service quantum-api_rest-aggregator-filesystems Removing service quantum-api_rest-aggregator-flexsync-hosts Removing service quantum-api_rest-aggregator-fseries-hosts Removing service quantum-api_rest-aggregator-hosts Removing service quantum-api_rest-aggregator-hseries-hosts Removing service quantum-api_rest-aggregator-metadata-controllers Removing service quantum-api_rest-aggregator-name-servers Removing service quantum-api_rest-aggregator-pseries-hosts Removing service quantum-api_rest-aggregator-qxs-hosts Removing service quantum-api_rest-aggregator-scalar-hosts Removing service quantum-api_rest-aggregator-usbe-hosts Removing service quantum-api_rest-aggregator-usbe-qxs-proxies Removing service quantum-api_rest-aggregator-xwd-hosts Removing service quantum-api_rest-aggregator-xwe-hosts Removing service quantum-api_rest-fs-create Removing service quantum-api_rest-registrar Removing service quantum-api_rest-templates Removing network quantum-api-external-net Removing network quantum-api-net /opt/quantum/fscreate_templates directory exists Creating network quantum-api-net Creating network quantum-api-external-net Creating service quantum-api_keycloak-database Creating service quantum-api_rest-fs-create Creating service quantum-api_rest-aggregator-usbe-hosts Creating service quantum-api_kong-database Creating service quantum-api_rest-aggregator-xwd-hosts Creating service quantum-api_rest-registrar Creating service quantum-api_rest-aggregator-hseries-hosts Creating service quantum-api_rest-aggregator-datamovers Creating service quantum-api_license-sender Creating service quantum-api_rest-aggregator-scalar-hosts Creating service quantum-api_rest-aggregator-activescale-hosts Creating service quantum-api_rest-aggregator-flexsync-hosts Creating service quantum-api_rest-aggregator-pseries-hosts Creating service quantum-api_rest-aggregator-appliance-controller-hosts Creating service quantum-api_rest-aggregator-name-servers Creating service quantum-api_endpoint-database Creating service quantum-api_rest-aggregator-hosts Creating service quantum-api_rest-aggregator-xwe-hosts Creating service quantum-api_rest-aggregator-qxs-hosts Creating service quantum-api_rest-templates Creating service quantum-api_license-aggregator Creating service quantum-api_kong-server Creating service quantum-api_keycloak-server Creating service quantum-api_rest-aggregator-filesystems Creating service quantum-api_gateway-admin-api Creating service quantum-api_rest-aggregator-fseries-hosts Creating service quantum-api_rest-aggregator-usbe-qxs-proxies Creating service quantum-api_rest-aggregator-metadata-controllers Waiting for response from kong-server container ....... Waiting for response from keycloak-server container ............................ Waiting for response from keycloak-server services