Start, Stop or Restart Your API Gateway (Service)
Use the following commands if you need to start, stop or restart your API gateway service. You can also use the shortcut commands on Start, Stop or Restart Your API Gateway that provide the same functionality.
Note: For a list of all the API gateway commands, see API Gateway (APIGW) Command Index.
Start Your API Gateway Service
- 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 service start
/opt/quantum/fscreate_templates directory exists Creating network quantum-api-net Creating network quantum-api-external-net Creating service quantum-api_rest-aggregator-pseries-hosts Creating service quantum-api_keycloak-database Creating service quantum-api_rest-aggregator-usbe-qxs-proxies Creating service quantum-api_rest-aggregator-qxs-hosts Creating service quantum-api_rest-aggregator-appliance-controller-hosts Creating service quantum-api_rest-templates Creating service quantum-api_rest-aggregator-datamovers Creating service quantum-api_gateway-admin-api Creating service quantum-api_rest-aggregator-xwd-hosts Creating service quantum-api_kong-server Creating service quantum-api_rest-aggregator-metadata-controllers Creating service quantum-api_keycloak-server Creating service quantum-api_kong-database Creating service quantum-api_license-sender Creating service quantum-api_rest-fs-create Creating service quantum-api_rest-aggregator-activescale-hosts Creating service quantum-api_rest-aggregator-fseries-hosts Creating service quantum-api_rest-aggregator-usbe-hosts Creating service quantum-api_rest-aggregator-filesystems Creating service quantum-api_rest-registrar Creating service quantum-api_rest-aggregator-name-servers Creating service quantum-api_rest-aggregator-xwe-hosts Creating service quantum-api_endpoint-database Creating service quantum-api_rest-aggregator-hosts Creating service quantum-api_license-aggregator Creating service quantum-api_rest-aggregator-hseries-hosts Creating service quantum-api_rest-aggregator-flexsync-hosts Creating service quantum-api_rest-aggregator-scalar-hosts Waiting for response from kong-server container ......... Waiting for response from keycloak-server container .................. Waiting for response from keycloak-server services
Stop Your API Gateway Service
- 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 service stop
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-net Removing network quantum-api-external-net
Restart Your API Gateway Service
- 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 service restart
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-net Removing network quantum-api-external-net /opt/quantum/fscreate_templates directory exists Creating network quantum-api-net Creating network quantum-api-external-net Creating service quantum-api_license-aggregator Creating service quantum-api_rest-aggregator-metadata-controllers Creating service quantum-api_rest-registrar Creating service quantum-api_rest-aggregator-filesystems Creating service quantum-api_endpoint-database Creating service quantum-api_license-sender Creating service quantum-api_rest-aggregator-datamovers Creating service quantum-api_rest-aggregator-xwe-hosts Creating service quantum-api_rest-aggregator-pseries-hosts Creating service quantum-api_rest-fs-create Creating service quantum-api_keycloak-database Creating service quantum-api_rest-aggregator-hosts Creating service quantum-api_rest-aggregator-activescale-hosts Creating service quantum-api_rest-templates Creating service quantum-api_gateway-admin-api Creating service quantum-api_rest-aggregator-fseries-hosts Creating service quantum-api_kong-database Creating service quantum-api_rest-aggregator-hseries-hosts Creating service quantum-api_rest-aggregator-scalar-hosts Creating service quantum-api_rest-aggregator-name-servers Creating service quantum-api_rest-aggregator-usbe-qxs-proxies Creating service quantum-api_rest-aggregator-flexsync-hosts Creating service quantum-api_rest-aggregator-appliance-controller-hosts Creating service quantum-api_kong-server Creating service quantum-api_rest-aggregator-qxs-hosts Creating service quantum-api_keycloak-server Creating service quantum-api_rest-aggregator-xwd-hosts Creating service quantum-api_rest-aggregator-usbe-hosts Waiting for response from kong-server container ......... Waiting for response from keycloak-server container .......... Waiting for response from keycloak-server services
