hdb.a: Managing Application Instances

The hdb.a family of commands controls instances of the provisioning software's applications, such as Remote Agents and Local Distributors.

Table 7–2 Summary of hdb.a Commands

Command Name	Description
hdb.a.add	Adds a new application instance
hdb.a.del	Deletes an application instance
hdb.a.la	Lists all application instances
hdb.a.lo	Retrieves information about a specific application instance
hdb.a.mod	Modifies an existing application instance
hdb.a.clear	Clears the resource cache of an application instance

hdb.a.add

This command adds a new application instance; it registers a specific configuration of a specific N1 Grid Service Provisioning System software application with the Master Server.

Table 7–3 Arguments and Result for the hdb.a.add Command

Argument/Result		Syntax	Description
hID	[R]	HostID	The ID of the host to contain the new instance
type	[R]	AppType	The application type (RA|LD)
pID	[R]	AppInstanceID	The parent application ID
ip	[R]	String	The application IP address (x.y.z.w)
port	[O]	Integer	The application port (not required for ssh)
conn	[R]	ConnectionType	The connection type (raw|ssh|ssl)
param	[O]	String	The parameters
result		UIAppInstanceUpdate	The new application instance and associated warnings

---

Note –

Omitting the -port argument or setting the port to 0 on an application instance with connection type ssh will cause the default ssh port to be used.

---

hdb.a.del

This command deletes an application instance from the Master Server's internal files. Once deleted, the application instance is no longer recognized by the Master Server.

---

Note –

Deleting an application instance does not delete N1 Grid Service Provisioning System software files on the machine where the application instance was installed.

---

Table 7–4 Argument for the hdb.a.del Command

Argument		Syntax	Description
ID	[R]	AppInstanceID	The application instance ID

hdb.a.la

This command lists all the application instances known to the Master Server.

This command does not accept any arguments.

Table 7–5 Result Returned by the hdb.a.la command

Result	Result Syntax	Description
result	AppInstanceArray	The application instances

hdb.a.lo

This command retrieves information about a specified application instance.

Table 7–6 Argument and Results of the hdb.a.lo Command

Argument/Result		Syntax	Description
ID	[R]	AppInstanceID	The application instance ID
result		AppInstance	The application instance

hdb.a.mod

This command modifies the specified attributes of an existing application instance. Omitted arguments preserve current values.

Table 7–7 Arguments and Result for the hdb.a.mod Command

Argument/Result		Syntax	Description
ID	[R]	AppInstanceID	The application instance ID
pID	[O]	AppInstanceID	The new parent application ID
ip	[O]	String	The new application IP address (x.y.z.w)
port	[O]	Integer	The new application port
conn	[O]	ConnectionType	The new connection type (raw|ssh|ssl)
param	[O]	String	The new parameters
result		UIAppInstanceUpdate	The modified application instance and associated warnings

---

Note –

Omitting the -port argument or setting the port to 0 on an application instance with connection type ssh will cause the default ssh port to be used.

---

hdb.a.clear

This command clears the resource cache of an application instance.

Table 7–8 Arguments and Result for the hdb.a.clear Command

Argument/Result		Syntax	Description
ID	[R]	AppInstanceID	The application instance ID