can anyone let us know why we API call catalog/images get back image id of client seems from replication, not local master backup, how we get local master server image id of backup client?

A complete curl command for the above filter looks like this: curl -k -X 'GET' 'https://master/netbackup/catalog/images?filter=clientName%20eq%20%27myclient%27%20and%20backupTime%20ge%202023-04-01T10:00:00.000Z%20and%20backupTime%20le%202023-04-20T00:00:00.000Z' -H 'accept: application/vnd.netbackup+json;version=9.0' -H 'Authorization: <auth string>'

API call catalog/images

32 Replies

uncleAIroh
Level 3
3 years ago
is there any way to get previous backup image id from API call catalog/images? we only get back image id in last 24 hours, even with query params = { 'sortBy': 'backupTime', 'sortOrder': 'asc', 'showAllVersions': 'true' }, stll back current version
- davidmoline
  Level 6
  3 years ago
  Hi uncleAIroh
  
  I imagine you are not correctly specifying the filter to your call. Can you please share the call you are makeing so we can see why it may not be correct. I assume what you are seeing would be the equivalent of running bpimagelist without any time arguements which returns the past 24 hours only, while what you are after is the image list from some time range in the past.
  
  Thanks
  David
  - uncleAIroh
    Level 3
    3 years ago
    code as following;
    # provide client asset id
    mfiler="( clientName eq "asset_id")"
    params = { ' filter':mfilter, 'sortBy': 'backupTime', 'sortOrder': 'desc', 'showAllVersions': 'true' }
    # Set the API headers
    headers = { 'Authorization': 'Bearer token', 'Content-Type': 'application/json' }
    # Send the API request
    response = requests.get(api_url, filter=mfilter params=params, headers=headers)
    we only get back latest backup image id with this code
uncleAIroh
Level 3
3 years ago
Tanks for your responding, we want to use API call to find master server catalog DB size, how much allocated, how many white space in catalog DB can be cleanup ( or defrag) when was last successful backup
uncleAIroh
Level 3
3 years ago
which version NetBackup has API endpoint /admin/catalog/size and /admin/storage/servers or never have?
uncleAIroh
Level 3
3 years ago
can we enable endpoint by modifying webapi.conf? such as /command/bpimagelist and so on
- davidmoline
  Level 6
  3 years ago
  Hi uncleAIroh
  
  uncleAIroh wrote:
  
  we want to use API call to find master server catalog DB size, how much allocated, how many white space in catalog DB can be cleanup ( or defrag) when was last successful backup
  
  There is no direct API for this. The best you could do for successful DB backup is to use the jobs to check for the last catalog backup. The rest wouldn't really make sense to create an API for.
  
  uncleAIroh wrote:
  
  which version NetBackup has API endpoint /admin/catalog/size and /admin/storage/servers or never have?
  
  Storage server API's have been available for a whjile now (at least since v 9). There is no API for catalog size.
  
  uncleAIroh wrote:
  
  can we enable endpoint by modifying webapi.conf? such as /command/bpimagelist and so on
  
  I can't see this as being something that Veritas would support or condone if even possible.
  
  Cheers
  David
uncleAIroh
Level 3
3 years ago
we tried to add backup host to master by API with endpoint /config/hosts, post payload as
add_host_payload = { "data": { "attributes": { "hostName": host_name, "osType": "WINDOWS" # or "UNIX" }, "type": "host" } }
host_name="newclient"
we always get message: {'errorCode': 8708, 'errorMessage': 'Constraint violations are detected for the given attributes in the input request.', 'attributeErrors': {}, 'fileUploadErrors': [], 'errorDetails': ['Constraint violations are detected for the given attributes in the input request: hostName ']}
we change different name, we got same result how we fix this issue
- davidmoline
  Level 6
  3 years ago
  Hi uncleAIroh
  
  The error indicates you have not sent the API request in the correct form/format. One thing the client host name should be referenced as "hostName" - beyond that.... without the actual API call you made, it is very difficult to help.
  
  David
uncleAIroh
Level 3
3 years ago
requests.post(add_host_url, header=headers json=add_host_payload)
add_host_url = https://{nb_server}:{nb_port}/netbackup/config/hosts
headers= {"Current-Type": "CLIENT", "Authentication": jwt}
- davidmoline
  Level 6
  3 years ago
  Hi uncleAIroh
  
  Given the command appears to be the equivalent of the CLI "nbemcmd -addhost" I think you will need to add more paramters into your data body than you have shown.
  
  Also not sure why the "Current-Type": "CLIENT" is included - I do not see any requirement for this and to me it appeaars that this also could be cuasing some problems.
  
  Finally - there is not header paramter shown for "Content-Type" which again would cause problems.
  
  I would suggest using the api-docs section to try your calls manually before looking to program them (https://<master>/api-docs) or use a program such as postman to get the calls working first.
  
  David
  - uncleAIroh
    Level 3
    3 years ago
    sorry typo following is query we used;
    payload = {'data': {'attributes': {'hostName': 'hostname, 'osType': 'UNIX'}, 'type': 'host'}}
    headers = {'Content-Type': 'application/json', 'Authorization': jwt};
    following is code;
    host_name = a
       os_type = "attributes": {
                "hostName": "host_name",
                "osType": "UNIX"
                #"nbuHostType":"CLIENT"
            },
            "type": "host"
            }
          }
    
       add_host_response = requests.post(url, headers=headers, json=add_host_payload, verify=False)
    is this hosts only mean for media server or include backup client? if we need to add backup clients, do we need to add host to master first?
    we test another way add client to policy as following
    headers = {'Content-Type': 'application/json', 'Authorization': ': jwt}
    url = "https://master/netbackup/config/policies/policyname/clients"
    add_host_payload = {'clientName': 'servername, 'osType': 'UNIX'}
    got follwoing error message; get command without issue, when we use put got following error message
    ssl.SSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:877)
    requests.put(url, headers=headers, json=add_host_payload, verify=False)
uncleAIroh
Level 3
3 years ago
we following your recommendation for webGUI can api add host to Master thanks !!
but when we try to add host to policy endpoint
url = "https://master/netbackup/config/policies/policyname/clients/clientname"
Swagger provide payload as following;
what is type and id we have put in?
{
"data": {
    "type": "string",
    "id": "string",
    "attributes": {
      "availabilityGroup": "string",
      "cluster": "string",
      "databaseName": "string",
      "dbid": "string",
      "dbUniqueName": "string",
      "groupID": "string",
      "instanceName": "string",
      "OS": "string",
      "hardware": "string",
      "nasVendor": "string"
    }
}
}
uncleAIroh
Level 3
3 years ago
also we can add host from GUIAPI, while we wrote python code with payload {"hostName": "host"}, we can add host to master too, but reponse.json() "Expecting value: line 1 column 1 (char 0)", error message, also the response file is all hosts in master not only for new host just add
uncleAIroh
Level 3
3 years ago
we can add client to policy with API successful right now, but need to put hardware type,
we need to add 100s client by API for one script run, the question if add client to policy, the NBU client installed later, what would be happen? can master server smarter to update status of client info in master?
- davidmoline
  Level 6
  3 years ago
  Having the client hardware type accurate is not critical in a policy - it does have implications when you use NetBackup to upgrade (either of vxupdate or install_client), but for just running backups, not so much.
uncleAIroh
Level 3
3 years ago
do you mean we can add all backup clients to policy, and install backup clients later would be fine, isn't it? when backup client installed, client will use certificate connect mater and update client information, am I correct?
- davidmoline
  Level 6
  3 years ago
  Adding clients to policy - all good, but you will need to manage those clients that don't yet have an agent (disable the polciy or deactivate the client until you install it) or have backup failures to those clients without an agent. There may be an API (/config/paused-clients) if your NBU version is high enough.
  
  When you install the NetBackup agent, it should then be able to get the host certificate (and CA cert) from the master without a token (unless you have security set very high). This will NOT update anything in the policy though (client or otherwise) - you would need to do that separately.
  - uncleAIroh
    Level 3
    3 years ago
    do you mean if we deactive those client we will not get error message? using /config/paused-clients API to deactive? what is Netbackup version needed

Forum Discussion

API call catalog/images

32 Replies

Related Content

API call from Windows

Netbackup Appliance API calls not working

api call creating a SLO

API call to show backup jobs within the last 7 days

Delete backup image from Catalog