ADM NITRO APIs

global_service_graph_config_mapping

Configuration for Config Data for Global Service Graph resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
k8s_pod_ip Read-write POD Ip.
ns_ip_address Read-write Device IP Address.
rec_type Read-write Record Identifier.
gslbvserver_name Read-write GSLB VServer Name.
lbvserver_name Read-write LB VServer Name.
id Read-write Id is system generated key.
csvserver_name Read-write CS VServer Name.
k8s_labels Read-write Labels in Kubernetes.
k8s_cluster_name Read-write Kubernetes cluster name.

Maximum length = 255
gslb_adc_display_name Read-write GSLB Device IP Address.
rpt_sample_time Read-write Report Sample time..
display_name Read-write Device IP Address.
k8s_namespace Read-write Namespace of service in Kubernetes.

Maximum length = 255
gslb_adc_ip Read-write GSLB ADC IP.
servername Read-write Server Name.
svc_name Read-write Service Name.
k8s_pod_name Read-write Pod Name in Kubernetes.
k8s_pod_state Read-write Pod State in Kubernetes.
k8s_service_name Read-write Service Name in Kubernetes.

Maximum length = 255

Operations

(click to see Properties )

  • GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/global_service_graph_config_mapping Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/global_service_graph_config_mapping ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of global_service_graph_config_mapping resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/global_service_graph_config_mapping ?pagesize=#no;pageno=#no Use this query-parameter to get the global_service_graph_config_mapping resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/global_service_graph_config_mapping ?count=yes Use this query-parameter to get the count of global_service_graph_config_mapping resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "global_service_graph_config_mapping":[{
"k8s_pod_ip":<String_value>,
"ns_ip_address":<String_value>,
"rec_type":<String_value>,
"gslbvserver_name":<String_value>,
"lbvserver_name":<String_value>,
"id":<String_value>,
"csvserver_name":<String_value>,
"k8s_labels":<String_value>,
"k8s_cluster_name":<String_value>,
"gslb_adc_display_name":<String_value>,
"rpt_sample_time":<Double_value>,
"display_name":<String_value>,
"k8s_namespace":<String_value>,
"gslb_adc_ip":<String_value>,
"servername":<String_value>,
"svc_name":<String_value>,
"k8s_pod_name":<String_value>,
"k8s_pod_state":<String_value>,
"k8s_service_name":<String_value>}]}

<!--NeedCopy-->
global_service_graph_config_mapping