site_node::get_children (public)

 site_node::get_children [ -all ] [ -package_type package_type ] \
    [ -package_key package_key ] [ -filters filters ] \
    [ -element element ] -node_id node_id

Defined in packages/acs-tcl/tcl/site-nodes-procs.tcl

This proc gives answers to questions such as: What are all the package_id's (or any of the other available elements) for all the instances of package_key or package_type mounted under node_id xxx?

Switches:

-all (optional, boolean)

-package_type (optional)

-package_key (optional)

If specified, this will limit the returned nodes to those with a package of the specified package key mounted. Conflicts with the -package_type option. Can take one or more packages keys as a Tcl list.

-filters (optional)

Takes a list of { element value element value ... } for filtering the result list. Only nodes where element is value for each of the filters in the list will get included. For example: -filters { package_key "acs-subsite" }.

-element (optional)

The element of the site node you wish returned. Defaults to url, but the following elements are available: object_type, url, object_id, instance_name, package_type, package_id, name, node_id, directory_p.

-node_id (required)

The node for which you want to find the children.

Options:

-all

Set this if you want all children, not just direct children

-package_type

If specified, this will limit the returned nodes to those with a package of the specified package type (normally apm_service or apm_application) mounted. Conflicts with the -package_key option.

Returns:

A list of URLs of the site_nodes immediately under this site node, or all children, if the -all switch is specified.

Testcases:

site_node_get_children, site_node_verify_folder_name