vas.web_server¶

`Groups`¶

class vas.web_server.Groups.Group[source]¶

Bases: vas.shared.Groups.Group

A Web Server group

Variables:	installations (vas.web_server.Installations.Installations) – The group’s installations instances (vas.web_server.Instances.Instances) – The groups’ 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.web_server.Groups.Groups[source]¶

Bases: vas.shared.Groups.Groups

Used to enumerate, create, and delete Web Server 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.web_server.InstallationImages.InstallationImage[source]¶

Bases: vas.shared.InstallationImages.InstallationImage

A Web Server installation image

Variables:

architecture (str) – The installation image’s architecture
installations (vas.web_server.Installations.Installations) – The installations that have been created from the installation image
operating_system (str) – The installation image’s operating system
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.web_server.InstallationImages.InstallationImages[source]¶

Bases: vas.shared.InstallationImages.InstallationImages

Used to enumerate, create, and delete Web Server installation images

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

create(path, version, architecture, operating_system)[source]¶

Creates an installation image by uploading a file to the server and assigning it a version, architecture, and operating system

Parameters:	path (str) – The path of the file to upload version (str) – The installation image’s version architecture (str) – The installation image’s architecture operating_system (str) – The installation image’s operating system
Return type:	`vas.web_server.InstallationImages.InstallationImage`
Returns:	The new installation image

reload()¶: Reloads the resource’s details from the server

`Installations`¶

class vas.web_server.Installations.Installation[source]¶

Bases: vas.shared.Installations.Installation

A Web Server installation

Variables:

group (vas.web_server.Groups.Group) – The group that contains the installation
installation_image (vas.web_server.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()[source]¶: Reloads the installation’s details from the server

class vas.web_server.Installations.Installations[source]¶

Bases: vas.shared.Installations.Installations

Used to enumerate, create, and delete Web Server 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.web_server.Instances.Instance[source]¶

Bases: vas.shared.Instance.Instance

A Web Server instance

Variables:

group (vas.web_server.Groups.Group) – The group that contains this instance
installation (vas.web_server.Installations.Installation) – The installation that this instance is using
live_configurations (vas.web_server.LiveConfigurations.LiveConfigurations) – The instance’s live configurations
name (str) – The instance’s name
node_instances (list) – The instance’s individual node instances
pending_configurations (vas.web_server.PendingConfigurations.PendingConfigurations) – 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)[source]¶

Updates the installation used by the instance

Parameters:	installation (vas.web_server.Installations.Installation) – The installation to be used by the instance

class vas.web_server.Instances.Instances[source]¶

Bases: vas.shared.MutableCollection.MutableCollection

Used to enumerate, create, and delete Web Server instances

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

create(installation, name, properties=None)[source]¶

Creates a new instance

Parameters:	installation (vas.web_server.Installations.Installation) – The installation to be used by the instance name (str) – The name of the instance properties (dict) – Optional properties to use when creating the instance
Return type:	`vas.web_server.Instances.Instance`
Returns:	The new instance

reload()¶: Reloads the resource’s details from the server

`LiveConfigurations`¶

class vas.web_server.LiveConfigurations.LiveConfiguration[source]¶

Bases: vas.shared.LiveConfiguration.LiveConfiguration

A live configuration file in a Web Server instance

Variables:

content (str) – The configuration’s content
instance (vas.web_server.Instances.Instance) – The instance that 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.web_server.LiveConfigurations.LiveConfigurations[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate an 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.web_server.Logs.Log[source]¶

Bases: vas.shared.Logs.Log

A log file in a Web Server node instance

Variables:	instance (vas.web_server.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.web_server.Logs.Logs[source]¶

Bases: vas.shared.Logs.Logs

Used to enumerate a Web Server 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.web_server.NodeInstances.NodeInstance[source]¶

Bases: vas.shared.NodeInstances.NodeInstance

A Web Server node instance

Variables:

group_instance (vas.web_server.Instances.Instance) – The node instance’s group instance
live_configurations (vas.web_server.LiveConfigurations.LiveConfigurations) – The node instance’s live configuration
logs (vas.web_server.Logs.Logs) – The instance’s logs
name (str) – The instance’s name
node (vas.web_server.Nodes.Node) – 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.web_server.NodeInstances.NodeInstances[source]¶

Bases: vas.shared.NodeInstances.NodeInstances

Used to enumerate Web Server 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.web_server.NodeLiveConfigurations.NodeLiveConfiguration[source]¶

Bases: vas.shared.NodeConfiguration.NodeConfiguration

A live configuration file in a node instance

Variables:

content (str) – The configuration’s content
group_configuration (vas.web_server.LiveConfigurations.LiveConfiguration) – The node configuration’s group configuration
instance (vas.web_server.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.web_server.NodeLiveConfigurations.NodeLiveConfigurations[source]¶

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

`Node`¶

class vas.web_server.Nodes.Node[source]¶

Bases: vas.shared.Nodes.GroupableNode

A Web Server 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.web_server.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.web_server.Nodes.Nodes[source]¶

Bases: vas.shared.Collection.Collection

Used to enumerate Web Server nodes

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

reload()¶: Reloads the resource’s details from the server

`PendingConfigurations`¶

class vas.web_server.PendingConfigurations.PendingConfiguration[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfiguration

A configuration file that is pending

Variables:	content (str) – The configuration’s content instance (vas.web_server.Instances.Instance) – The instance that 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.web_server.PendingConfigurations.PendingConfigurations[source]¶

Bases: vas.shared.PendingConfigurations.PendingConfigurations

Used to enumerate an 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

`WebServer`¶

class vas.web_server.WebServer.WebServer[source]¶

Bases: object

The entry point to the API for administering vFabric Web Server

Variables:	groups (vas.web_server.Groups.Groups) – The Web Server groups installation_images (vas.web_server.InstallationImages.InstallationImages) – The Web Server installation images nodes (vas.web_server.Nodes.Nodes) – The Web Server nodes

vas.web_server¶

`Groups`¶

`InstallationImages`¶

`Installations`¶

`Instances`¶

`LiveConfigurations`¶

`Logs`¶

`NodeInstances`¶

`NodeLiveConfigurations`¶

`Node`¶

`PendingConfigurations`¶

`WebServer`¶

Table Of Contents

Previous topic

Navigation

vas.web_server¶

Groups¶

InstallationImages¶

Installations¶

Instances¶

LiveConfigurations¶

Logs¶

NodeInstances¶

NodeLiveConfigurations¶

Node¶

PendingConfigurations¶

WebServer¶

Table Of Contents

Previous topic

Quick search

Navigation

`Groups`¶

`InstallationImages`¶

`Installations`¶

`Instances`¶

`LiveConfigurations`¶

`Logs`¶

`NodeInstances`¶

`NodeLiveConfigurations`¶

`Node`¶

`PendingConfigurations`¶

`WebServer`¶