resource-v13 - describes the Rundeck resource model document
The Resource Model XML document declares a resource model that can also be uploaded to a project hosted on the Rundeck server. This document describes the format and necessary elements.
The root (aka “top-level”) element of the resource file is called
Project defines all the resources.
Can contain the following elements:
A node resource element.
The node element defines a Node resource.
The node name. This is a logical identifier from the node. (required)
A brief description about the node. (optional)
The hostname or IP address of the remote host. (required)
The operating system architecture. (optional)
The operating system family, such as unix or windows. (optional)
The operating system name such as Linux or Mac OS X. (optional)
Comma separated list of filtering tags. (optional) Tags are used for filtering nodes and often represent server role, environment, class, or group.
The username used for the remote connection. (required)
URL to an external resource model editor service (optional)
URL to an external resource model service. (optional)
Any user-supplied attributes can be specified to add additional metadata about a node.
Further user defined attributes.
Defines a single metadata attribute for the node, as an alternative to specifying it as a XML attribute on the
<node> element itself.
The name of the attribute
The value of the attribute
Alternatively, the value can be specified as nested text content.
Define a node named “strongbad”:
Define a node of the type LinuxNode that has a
Define a node named that uses a non standard SSH port. The “hostname” value is overloaded to include the port (192.168.1.106:4022):
An example using just the required attributes:
An example with a custom attribute “appname” specified in the
An example with tags and custom attributes that describe the server role and environment for this node:
The Rundeck source code and all documentation may be downloaded from https://github.com/rundeck/rundeck/.