OpenAPI User Guide > OpenAPI User Guide > Accessing the Name Server > Name Server Query Statement Syntax
Was this helpful?
Name Server Query Statement Syntax
The Name Server query text is divided into fields, which are separated by a blank space. The first four fields of a query text statement describe the action to be performed and the virtual node name with which the action is associated. These four fields appear in the following order in each query statement:
Field
Parameter
Value
Description
1
Function
create, destroy, or show
The task that will be performed.
2
Type
global or private
The registration type of the object. A global object is available to all users on the local node. A private object is available to a single user. Private objects are created and destroyed for the currently logged-in user. Only a user with the NET_ADMIN GCA privilege (generally a system administrator) can create and destroy global objects.
3
Object
login, connection, or attribute
The object to be created, destroyed, or shown. Login is the remote user authorization definition (user name and password). Connection refers to a connection data definition. Attribute refers to the attribute of the virtual node.
4
Virtual node name
vnode name
The virtual node name (vnode) associated with the operation. Each query statement must contain a vnode identifier.
Note:  A single-letter abbreviation is sufficient for the first three fields (function, type, and object). Virtual node names cannot be abbreviated. For query text statements that specify either the destroy or show function, you can enter the asterisk character (*) as a wildcard in any field other than the function, type, and object fields. Wildcards cannot be used with the create function.
Last modified date: 12/14/2023