Working with NetBackup Flex Scale APIs
NetBackup Flex Scale employs a dedicated nginx-based web server that runs the API gateway and the management server. All UI access and API requests are sent to this web server. A single IP address and FQDN is used for accessing the NetBackup Flex Scale infrastructure UI as well as the NetBackup Web UI.
You can access the NetBackup Flex Scale infrastructure management UI using the following URL:
https://ManagementServerIPorFQDN:14161If you are using IPv6 addresses, use the following URL syntax:
https://[ManagementServerIP]:14161You can access the NetBackup Web UI using the following URL:
https://ManagementServerIPorFQDN/webuiIf you are using IPv6 addresses, use the following URL syntax:
https://[ManagementServerIP]/webui
Here, ManagementServerIPorFQDN is the public IP address, the FQDN, or the short host name that you specified for the NetBackup Flex Scale management server during the cluster configuration.
Note:
If you access the NetBackup Flex Scale infrastructure management UI by using the short host name from a node, set the DNS settings (name server, domain name, and search domain) or ensure that the entry for mapping the short host name to an IP address exists in the hosts file of the node.
NetBackup Flex Scale provides APIs that are built using the standard Representational State Transfer (REST) architecture. You can use the RESTful APIs to control all aspects of your NetBackup Flex Scale configuration. There are APIs for infrastructure monitoring and management, user management, and for performing several other operations in your cluster.
You can access the NetBackup Flex Scale APIs using the Swagger interface.
To access the APIs from a web browser
Open your browser and enter the following URL in the address bar:
https://ManagementServerIPorFQDN:14161/swagger/infra/v1.0If you are using IPv6 addresses, use the following URL syntax:
https://[ManagementServerIP]:14161/swagger/infra/v1.0Here, ManagementServerIPorFQDN is the public IP address, the FQDN, or the short host name that you specified for the NetBackup Flex Scale management server and API gateway during the cluster configuration.
Note:
If you access the NetBackup Flex Scale infrastructure management console by using the short host name from a node, set the DNS settings (name server, domain name, and search domain) or ensure that the entry for mapping the short host name to an IP address exists in the hosts file of the node.
For a quick introduction on how to use the APIs, refer to the getting started readme available at the following URL:
https://ManagementServerIPorFQDN:14161/swagger/infra/v1.0/readmeIf you are using IPv6 addresses, use the following URL syntax:
https://[ManagementServerIP]:14161/swagger/infra/v1.0/readme
For more information on APIs, refer to the Veritas NetBackup Flex Scale API documentation on SORT.
You can access the sample SDKs here:
https://github.com/VeritasOS/NetBackup-Flex-Scale-REST-API-nuggets