vas.rabbitmq

Groups

class vas.rabbitmq.Groups.Group

Bases: vas.shared.Groups.Group

A RabbitMQ group

Variables:

• installations (vas.rabbitmq.Installations.Installations) – The group’s installations
• instances (vas.rabbitmq.Instances.Instances) – The group’s instances
• name (str) – The group’s name
• nodes (list) – The group’s nodes
• security (vas.shared.Security) – The resource’s security

delete()

Performs a delete. If a collection is available it is reloaded.

reload()

Reloads the group’s details from the server

---

class vas.rabbitmq.Groups.Groups

Bases: vas.shared.Groups.Groups

Used to enumerate, create, and delete RabbitMQ groups

Variables:security (vas.shared.Security.Security) – The security configuration for the collection

create(name, nodes)

Creates a new group

Parameters:

• name (str) – The group’s name
• nodes (list) – The group’s nodes

Return type:

vas.shared.Groups.Group

Returns:

The new group

reload()

Reloads the resource’s details from the server

InstallationImages

class vas.rabbitmq.InstallationImages.InstallationImage

Bases: vas.shared.InstallationImages.InstallationImage

A RabbitMQ installation image

Variables:

• installations (vas.rabbitmq.Installations.Installations) – The installations that have been created from the installation image
• security (vas.shared.Security.Security) – The resource’s security
• size (int) – The installation image’s size
• version (str) – The installation image’s version

delete()

Performs a delete. If a collection is available it is reloaded.

reload()

Reloads the installation image’s details from the server

---

class vas.rabbitmq.InstallationImages.InstallationImages

Bases: vas.shared.InstallationImages.InstallationImages

Used to enumerate, create, and delete RabbitMQ installation images

Variables:security (vas.shared.Security.Security) – The resource’s security

create(path, version)

Creates an installation image by uploading a file to the server and assigning it a version

Parameters:

• path (str) – The path of the file to upload
• version (str) – The installation image’s version

Return type:

vas.shared.InstallationImages.InstallationImage

Returns:

The new installation image

reload()

Reloads the resource’s details from the server

Installations

class vas.rabbitmq.Installations.Installation

Bases: vas.shared.Installations.Installation

A RabbitMQ installation

Variables:

• group (vas.rabbitmq.Groups.Group) – The group that contains the installation
• installation_image (vas.rabbitmq.InstallationImages.InstallationImage) – The installation image that was used to create the installation
• instances (list) – The instances that are using the installation
• security (vas.shared.Security.Security) – The resource’s security
• version (str) – The installation’s version

delete()

Performs a delete. If a collection is available it is reloaded.

reload()

Reloads the installation’s details from the server

---

class vas.rabbitmq.Installations.Installations

Bases: vas.shared.Installations.Installations

Used to enumerate, create, and delete RabbitMQ installations

Variables:security (vas.shared.Security.Security) – The resource’s security

create(installation_image)

Create a new installation

Parameters:installation_image (vas.shared.InstallationImages.InstallationImage) – The installation image to use to create the installation Return type:vas.shared.Installations.Installation Returns:The new installation

reload()

Reloads the resource’s details from the server

Instances

class vas.rabbitmq.Instances.Instance

Bases: vas.shared.Instance.Instance

A RabbitMQ instance

Variables:

• group (vas.rabbitmq.Groups.Group) – The group that contains this instance
• installation (vas.rabbitmq.Installations.Installation) – The installation that this instance is using
• live_configurations (vas.rabbitmq.LiveConfiguration.LiveConfiguration) – The instance’s live configurations
• name (str) – The instance’s name
• node_instances (list) – The instance’s individual node instances
• pending_configurations (vas.rabbitmq.PendingConfigurations.PendingConfiguration) – The instance’s pending configurations
• security (vas.shared.Security.Security) – The resource’s security
• state (str) –

  Retrieves the state of the resource from the server. Will be one of:

  • STARTING
  • STARTED
  • STOPPING
  • STOPPED

delete()

Performs a delete. If a collection is available it is reloaded.

reload()

Reloads the instance’s details from the server

start(serial=False)

Starts the resource

Parameters:serial (bool) – Whether to start the node instance serially

stop(serial=False)

Stops the resource

Parameters:serial (bool) – Whether to stop the node instance serially

update(installation)

Updates the instance to use a different installation

Parameters:installation (vas.rabbitmq.Installations.Installation) – The installation that the instance should use

---

class vas.rabbitmq.Instances.Instances

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete RabbitMQ instances

Variables:security (vas.shared.Security.Security) – The resource’s security

create(installation, name)

Creates a new instance

Parameters:

• name (str) – The name of the group instance
• installation (vas.rabbitmq.Installations.Installation) – The installation to be used by the instance

Return type:

vas.rabbitmq.Instances.Instance

Returns:

The new instance

reload()

Reloads the resource’s details from the server

LiveConfigurations

class vas.rabbitmq.LiveConfigurations.LiveConfiguration

Bases: vas.shared.LiveConfiguration.LiveConfiguration

A live configuration file in a RabbitMQ instance

Variables:

• content (str) – The configuration’s content
• instance (vas.rabbitmq.Instance.Instance) – The instance the owns the configuration
• path (str) – The configuration’s path
• node_configurations (list) – The configuration’s node configurations
• security (vas.shared.Security.Security) – The resource’s security
• size (int) – The configuration’s size

reload()

Reloads the live configuration’s details from the server

---

class vas.rabbitmq.LiveConfigurations.LiveConfigurations

Bases: vas.shared.Collection.Collection

Used to enumerate a RabbitMQ instance’s live configuration

Variables:security (vas.shared.Security.Security) – The resource’s security

reload()

Reloads the resource’s details from the server

Logs

class vas.rabbitmq.Logs.Log

Bases: vas.shared.Logs.Log

A log file in a RabbitMQ node instance

Variables:

• instance (vas.rabbitmq.NodeInstances.NodeInstance) – The node instance that the log belongs to
• last_modified (datetime.datetime) – The last modified stamp of the log
• name (str) – The name of the log
• security (vas.shared.Security.Security) – The resource’s security
• size (int) – The size of the log

content(start_line=None, end_line=None)

Get the content of the log

Parameters:

• start_line (int) – The start point, in lines, of the content to return. A value of None will result in content from the start of the file being returned. If the provided value is greater than the number of lines in the file, the returned content will be empty.
• end_line (int) – The end point, in lines, of the content to return. A value of None will result in content up to the end of the file being returned. If the provided value is greater than the number of lines in the file, content up to and including the last line in the file will be returned.

Return type:

str

Returns:

The root directory of the extracted agent

delete()

Performs a delete. If a collection is available it is reloaded.

reload()

Reloads the log’s details from the server

---

class vas.rabbitmq.Logs.Logs

Bases: vas.shared.Logs.Logs

Used to enumerate a RabbitMQ node instance’s logs

Variables:security (vas.shared.Security.Security) – The resource’s security

reload()

Reloads the resource’s details from the server

NodeInstances

class vas.rabbitmq.NodeInstances.NodeInstance

Bases: vas.shared.NodeInstances.NodeInstance

A RabbitMQ node instance

Variables:

• group_instance (vas.rabbitmq.Instance.Instance) – The node instance’s group instance
• live_configurations (vas.rabbitmq.LiveConfigurations.LiveConfigurations) – The node instance’s live configuration
• logs (vas.rabbitmq.Logs.Logs) – The instance’s logs
• name (str) – The instance’s name
• node (vas.rabbitmq.Nodes) – The node that contains this instance
• security (vas.shared.Security.Security) – The resource’s security
• state (str) –

  Retrieves the state of the resource from the server. Will be one of:

  • STARTING
  • STARTED
  • STOPPING
  • STOPPED

reload()

Reloads the resource’s details from the server

start()

Starts the resource

stop()

Stops the resource

---

class vas.rabbitmq.NodeInstances.NodeInstances

Bases: vas.shared.NodeInstances.NodeInstances

Used to enumerate RabbitMQ instances on an individual node

Variables:security (vas.shared.Security.Security) – The resource’s security

reload()

Reloads the resource’s details from the server

NodeLiveConfigurations

class vas.rabbitmq.NodeLiveConfigurations.NodeLiveConfiguration

Bases: vas.shared.NodeConfiguration.NodeConfiguration

A live configuration file in a node instance

Variables:

• content (str) – The configuration’s content
• group_configuration (vas.rabbitmq.LiveConfigurations.LiveConfiguration) – The node configuration’s group configuration
• instance (vas.rabbitmq.NodeInstances.NodeInstance) – The instance the owns the configuration
• path (str) – The configuration’s path
• security (vas.shared.Security.Security) – The resource’s security
• size (int) – The configuration’s size

reload()

Reloads the configuration’s details from the server

---

class vas.rabbitmq.NodeLiveConfigurations.NodeLiveConfigurations

Bases: vas.shared.Collection.Collection

Used to enumerate a node instance’s live configuration

Variables:security (vas.shared.Security.Security) – The resource’s security

reload()

Reloads the resource’s details from the server

Nodes

class vas.rabbitmq.Nodes.Node

Bases: vas.shared.Nodes.GroupableNode

A RabbitMQ node

Variables:

• agent_home (str) – The location of the vFabric Administration Agent
• architecture (str) – The architecture of the node’s operating system
• groups (list) – The groups that contain this node
• host_names (list) – The node’s host names
• instances (vas.rabbitmq.NodeInstances.NodeInstances) – The node’s instances
• ip_addresses (list) – The node’s IP addresses
• ipv4_addresses (list) – The node’s IPv4 addresses
• ipv6_addresses (list) – The node’s IPv6 addresses
• metadata (dict) – The node’s metadata
• operating_system (str) – The node’s operating system
• security (vas.shared.Security.Security) – The resource’s security

reload()

Reloads the node’s details from the server

update(metadata)

Updates the node’s metadata

Parameters:metadata (dict) – The node’s new metadata

---

class vas.rabbitmq.Nodes.Nodes

Bases: vas.shared.Collection.Collection

Used to enumerate RabbitMQ nodes

Variables:security (vas.shared.Security.Security) – The resource’s security

reload()

Reloads the resource’s details from the server

PendingConfigurations

class vas.rabbitmq.PendingConfigurations.PendingConfiguration

Bases: vas.shared.PendingConfigurations.PendingConfiguration

A RabbitMQ instance’s configuration file that is pending

Variables:

• content (str) – The configuration’s content
• instance (vas.rabbitmq.Instance.Instance) – The instance the owns the configuration
• path (str) – The configuration’s path
• security (vas.shared.Security.Security) – The resource’s security
• size (int) – The configuration’s size

delete()

Performs a delete. If a collection is available it is reloaded.

reload()

Reloads the configuration’s details from the server

---

class vas.rabbitmq.PendingConfigurations.PendingConfigurations

Bases: vas.shared.PendingConfigurations.PendingConfigurations

Used to enumerate a RabbitMQ instance’s pending configuration

Variables:security (vas.shared.Security.Security) – The resource’s security

create(path, content)

Creates a new configuration. The configuration will be pending until its instance is started at which point the configuration will become live.

Parameters:

• path (str) – The configuration’s path
• content (str) – The configuration’s content

Return type:

vas.shared.PendingConfigurations.PendingConfiguration

Returns:

The new configuration

reload()

Reloads the resource’s details from the server

PluginImages

class vas.rabbitmq.PluginImages.PluginImage

Bases: vas.shared.Resource.Resource, vas.shared.Deletable.Deletable

A plugin image

Variables:

• name (str) – The plugin image’s name
• plugins (vas.rabbitmq.Plugins.Plugins) – The plugins that have been created from this plugin image
• security (vas.shared.Security.Security) – The resource’s security
• size (int) – The plugin image’s size
• version (str) – The plugin image’s version

delete()

Performs a delete. If a collection is available it is reloaded.

reload()

Reloads the plugin image’s details from the server

---

class vas.rabbitmq.PluginImages.PluginImages

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete RabbitMQ plugin images

Variables:security (vas.shared.Security.Security) – The resource’s security

create(path)

Creates a new plugin image by uploading a file

Parameters:path (str) – The path of the plugin .ez file to upload Return type:vas.rabbitmq.PluginImages.PluginImage Returns:The new plugin image

reload()

Reloads the resource’s details from the server

Plugins

class vas.rabbitmq.Plugins.Plugin

Bases: vas.shared.Resource.Resource, vas.shared.Deletable.Deletable

A plugin in a RabbitMQ instance

Variables:

• instance (vas.rabbitmq.Instances.Instance) – The instance that contains the plugin
• name (str) – The plugin’s name
• plugin_image (vas.rabbitmq.PluginImages.PluginImage) – The plugin image, if any, that was used to create the plugin
• security (vas.shared.Security.Security) – The resource’s security
• state (str) –

  Retrieves the state of the plugin from the server. Will be one of:

  • ENABLED
  • DISABLED
• version (str) – The plugin’s version

delete()

Performs a delete. If a collection is available it is reloaded.

disable()

Disables the plugin

enable()

Enables the plugin

reload()

Reloads the resource’s details from the server

---

class vas.rabbitmq.Plugins.Plugins

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete plugins

Variables:security (vas.shared.Security.Security) – The resource’s security

create(plugin_image)

Creates a plugin from the plugin_image

Parameters:plugin_image (vas.rabbitmq.PluginImages.PluginImage) – The plugin image to create the plugin from Return type:vas.rabbitmq.Plugins.Plugin Returns:The new plugin

reload()

Reloads the resource’s details from the server

RabbitMq

class vas.rabbitmq.RabbitMq.RabbitMq

Bases: object

The entry point to the API for administering RabbitMQ

Variables:

• groups (vas.rabbitmq.Groups.Groups) – The RabbitMQ groups
• installation_images (vas.rabbitmq.InstallationImages.InstallationImages) – The RabbitMQ installation images
• nodes (vas.rabbitmq.Nodes.Nodes) – The RabbitMQ nodes
• plugin_images (vas.rabbitmq.PluginImages.PluginImages) – The RabbitMQ plugin images